Terminologieserver - Authoring - MaintainValueSet

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
 
(4 dazwischenliegende Versionen von einem Benutzer werden nicht angezeigt)
Zeile 1: Zeile 1:
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]<br><br>
  
 +
=Beschreibung=
 +
Create a new value set version or edit an existing one.<br>
 
=Request/Response=
 
=Request/Response=
 
==Request==
 
==Request==
Zeile 12: Zeile 14:
 
     <th>Beschreibung</th>
 
     <th>Beschreibung</th>
 
   </tr>
 
   </tr>
−
<tr id="row_object">
+
<tr>
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">LoginType</td>
+
   <td id="param_level1">loginToken</td>
−
  <td>LoginType</td>
+
−
<td></td>  <td id="cardinality_cell">0..1</td>
+
−
  <td>Login information</td>
+
−
</tr>
+
−
<tr>
+
−
  <td id="cardinality_cell">2</td>
+
−
  <td id="param_level2">password</td>
+
 
   <td>String</td>
 
   <td>String</td>
 
   <td></td>
 
   <td></td>
 
   <td id="cardinality_cell">1..1</td>
 
   <td id="cardinality_cell">1..1</td>
−
   <td>password from user (as MD5-hash)</td>
+
   <td>Login-Token that ensures the user is logged in.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">VersioningType</td>
+
   <td id="param_level1">versioning</td>
 
   <td>VersioningType</td>
 
   <td>VersioningType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 91: Zeile 86:
 
<td></td>  <td id="cardinality_cell">-</td>
 
<td></td>  <td id="cardinality_cell">-</td>
 
   <td>Represents  the version of an valueset.</td>
 
   <td>Represents  the version of an valueset.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">0..1</td>
 +
  <td></td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 96: Zeile 107:
 
   <td id="param_level3">preferredLanguageCd</td>
 
   <td id="param_level3">preferredLanguageCd</td>
 
   <td>String</td>
 
   <td>String</td>
−
   <td>19</td>
+
   <td>30</td>
 
   <td id="cardinality_cell">0..1</td>
 
   <td id="cardinality_cell">0..1</td>
−
   <td>The preferred langue of the code system. (The ID has to be taken from the domain 'ISO_639_1_Language_Codes' - ID 1)</td>
+
   <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 113: Zeile 124:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>The status of the current entry. Can be found in a domain.</td>
 
   <td>The status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr>
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">validityRange</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">0..1</td>
 +
  <td>Validity range (German: Gültigkeitsbereich)</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 135: Zeile 153:
 
<tr id="row_object">
 
<tr id="row_object">
 
   <td id="cardinality_cell">1</td>
 
   <td id="cardinality_cell">1</td>
−
   <td id="param_level1">ReturnType</td>
+
   <td id="param_level1">returnInfos</td>
 
   <td>ReturnType</td>
 
   <td>ReturnType</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
Zeile 163: Zeile 181:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
=Beispiele=
 +
==SOAP==
 +
===Simple sample===
 +
<source lang="xml">
 +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/">
 +
  <soapenv:Header/>
 +
  <soapenv:Body>
 +
      <aut:MaintainValueSet>       
 +
        <parameter>     
 +
            <valueSet>
 +
<id>1</id>
 +
<valueSetVersions>
 +
  <versionId>1</versionId>
 +
  <name>Changed Versionname</name>
 +
</valueSetVersions>
 +
            </valueSet>
 +
            <versioning>
 +
              <createNewVersion>1</createNewVersion>
 +
            </versioning>
 +
            <login>             
 +
              <sessionID>xxx</sessionID>             
 +
            </login>     
 +
        </parameter>
 +
      </aut:MaintainValueSet>
 +
  </soapenv:Body>
 +
  </soapenv:Envelope>
 +
</source>
 
<br><br>
 
<br><br>
  
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]
 
[[Terminologieserver - Webservice Dokumentation|zurück zur Webservice-Übersicht]]

Aktuelle Version vom 30. September 2014, 12:31 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

Create a new value set version or edit an existing one.

Request/Response

Request

Level Parameter Typ Länge Kardinalität Beschreibung
1 loginToken String 1..1 Login-Token that ensures the user is logged in.
1 versioning VersioningType 1..1 Versioning information
2 createNewVersion Boolean 1..1 true if a new version should be created
2 majorUpdate Boolean 0..1 true if major version should count up
2 minorUpdate Boolean 0..1 true if minor version should count up
1 valueSet value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
2 description String 65535 0..1 Description of the valueset.
2 id Long 1..1 ID of the valueset.
2 name String 50 1..1 Name of the valueset.
2 valueSetVersion value_set_version - Represents the version of an valueset.
3 name String 0..1
3 oid String 0..1
3 preferredLanguageCd String 30 0..1 Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
3 releaseDate java.util.Date 0..1 Start date for the validity of the valueset version.
3 status Integer 0..1 The status of the current entry. Can be found in a domain.
3 validityRange Long 0..1 Validity range (German: Gültigkeitsbereich)
3 versionId Long 1..1 Only mandatory, if no new version is put on.


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 returnInfos ReturnType 1..1 Return information
2 message String 1..1 an additional message
2 overallErrorCategory 1..1 INFO, WARN, ERROR
2 status 1..1 OK, FAILURE

Beispiele

SOAP

Simple sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <aut:MaintainValueSet>        
         <parameter>       
            <valueSet>
		<id>1</id>		
		<valueSetVersions>
		   <versionId>1</versionId>
		   <name>Changed Versionname</name>	
		</valueSetVersions>	
            </valueSet>
            <versioning>
               <createNewVersion>1</createNewVersion>
            </versioning>
            <login>              
               <sessionID>xxx</sessionID>              
            </login>       
         </parameter>
      </aut:MaintainValueSet>
   </soapenv:Body>
   </soapenv:Envelope>



zurück zur Webservice-Übersicht

Von „http://www.wiki.mi.fh-dortmund.de/cts2/index.php?title=Terminologieserver_-_Authoring_-_MaintainValueSet“
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge