Terminologieserver - Search - ReturnValueSetDetails

Aus Termserver-CTS2
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
(automatisch erstellt vom Webservice-Schnittstellen-Tool)
Zeile 28: Zeile 28:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 
   <td>A subset of terms.Every valueset has at least one valueset-version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">currentVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the current version of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">description</td>
 +
  <td>String</td>
 +
  <td>65535</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Description of the valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 35: Zeile 50:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>ID of the valueset.</td>
 
   <td>ID of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">name</td>
 +
  <td>String</td>
 +
  <td>50</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Name of the valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 
</tr>
 
</tr>
 
<tr id="row_object">
 
<tr id="row_object">
Zeile 42: Zeile 79:
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
<td></td>  <td id="cardinality_cell">0..1</td>
 
   <td>Represents  the version of an valueset.</td>
 
   <td>Represents  the version of an valueset.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">insertTimestamp</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Timestamp of the insertion of the valueset version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">name</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">oid</td>
 +
  <td>String</td>
 +
  <td></td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td></td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">preferredLanguageCd</td>
 +
  <td>String</td>
 +
  <td>30</td>
 +
  <td id="cardinality_cell">-</td>
 +
  <td>Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">previousVersionId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Points to the previous version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">releaseDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Start date for the validity of the valueset version.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">status</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>The status of the current entry. Can be found in a domain.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">statusDate</td>
 +
  <td>java.util.Date</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Alteration time of the status.</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">validityRange</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Validity range (German: Gültigkeitsbereich)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">valueSetId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to the ID of the valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 68: Zeile 178:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Return information</td>
 
   <td>Return information</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">2</td>
 +
  <td id="param_level2">count</td>
 +
  <td>Integer</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>number of results</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Zeile 274: Zeile 391:
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
<td></td>  <td id="cardinality_cell">1..1</td>
 
   <td>Validity range (German: Gültigkeitsbereich)</td>
 
   <td>Validity range (German: Gültigkeitsbereich)</td>
 +
</tr>
 +
<tr id="gray">
 +
  <td id="cardinality_cell">3</td>
 +
  <td id="param_level3">valueSetId</td>
 +
  <td>Long</td>
 +
<td></td>  <td id="cardinality_cell">-</td>
 +
  <td>Foreign key to the ID of the valueset.</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>

Version vom 30. September 2014, 12:20 Uhr

zurück zur Webservice-Übersicht

Inhaltsverzeichnis

Beschreibung

List all details of the given value set or value set version.

Request/Response

Request

Level Parameter Typ Länge Kardinalität Beschreibung
1 loginToken String 0..1 Login-Token that ensures the user is logged in.
1 valueSet value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
2 currentVersionId Long - Points to the current version of the valueset.
2 description String 65535 - Description of the valueset.
2 id Long 0..1 ID of the valueset.
2 name String 50 - Name of the valueset.
2 status Integer - Status of the current entry. Can be found in a domain.
2 statusDate java.util.Date - Alteration time of the status.
2 valueSetVersion value_set_version 0..1 Represents the version of an valueset.
3 insertTimestamp java.util.Date - Timestamp of the insertion of the valueset version.
3 name String -
3 oid String -
3 preferredLanguageCd String 30 - Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
3 previousVersionId Long - Points to the previous version.
3 releaseDate java.util.Date - Start date for the validity of the valueset version.
3 status Integer - The status of the current entry. Can be found in a domain.
3 statusDate java.util.Date - Alteration time of the status.
3 validityRange Long - Validity range (German: Gültigkeitsbereich)
3 valueSetId Long - Foreign key to the ID of the valueset.
3 versionId Long 1..1 Version ID of the value set


Response

Level Parameter Typ Länge Kardinalität Beschreibung
1 returnInfos ReturnType 1..1 Return information
2 count Integer - number of results
2 message String 1..1 an additional message
2 overallErrorCategory 1..1 INFO, WARN, ERROR
2 status 1..1 OK, FAILURE
1 valueSet value_set 1..1 A subset of terms.Every valueset has at least one valueset-version.
2 currentVersionId Long 1..1 Points to the current version of the valueset.
2 description String 65535 1..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 status Integer 1..1 Status of the current entry. Can be found in a domain.
2 statusDate java.util.Date 1..1 Alteration time of the status.
2 metadataParameter metadata_parameter 0..N Contains an accumulation of meta data. (List of the available descriptions)
3 codeSystemId Long 1..1 If set, this entry belongs to a code system.
3 id Long 1..1
3 languageCd String 30 1..1
3 metadataParameterType String 30 1..1 Type of the meta data. A possible list of values is contained in the domain table.
3 paramDatatype String 65535 1..1 Data type of the value in code_system_metadata_value.
3 paramName String 65535 1..1 Description of meta data (e.g. measurement unit)
3 valueSetId Long 1..1 If set, this entry belongs to a value set.
2 valueSetVersion value_set_version 1..N Represents the version of an valueset.
3 insertTimestamp java.util.Date 1..1 Timestamp of the insertion of the valueset version.
3 name String 1..1
3 oid String 1..1
3 preferredLanguageCd String 30 1..1 Preferred language of value set version. Value comes from the ISO 639-1 ('de' for German, 'en' for English, ...)
3 previousVersionId Long 1..1 Points to the previous version.
3 releaseDate java.util.Date 1..1 Start date for the validity of the valueset version.
3 status Integer 1..1 The status of the current entry. Can be found in a domain.
3 statusDate java.util.Date 1..1 Alteration time of the status.
3 validityRange Long 1..1 Validity range (German: Gültigkeitsbereich)
3 valueSetId Long - Foreign key to the ID of the valueset.
3 versionId Long 1..1 Version ID of the value set

Beispiele

SOAP

Get details for a valueset

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/">
   <soapenv:Header/>
   <soapenv:Body>
      <sear:ReturnValueSetDetails>
        <parameter>
           <valueSet>
              <valueSetVersions>
                <versionId>3</versionId>
	         </valueSetVersions>
           </valueSet>
        </parameter>  
      </sear:ReturnValueSetDetails>
   </soapenv:Body>
</soapenv:Envelope>



zurück zur Webservice-Übersicht

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