Terminologieserver - Search - ListConceptAssociationTypes
Aus Termserver-CTS2
(Unterschied zwischen Versionen)
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
(automatisch erstellt vom Webservice-Schnittstellen-Tool) |
||
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= | ||
+ | Lists all association types. There are general associations available for all code systems, but also associations available in specific code systems only.<br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
Zeile 12: | Zeile 14: | ||
<th>Beschreibung</th> | <th>Beschreibung</th> | ||
</tr> | </tr> | ||
− | <tr | + | <tr> |
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
− | <td id="param_level1"> | + | <td id="param_level1">loginToken</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
<td>String</td> | <td>String</td> | ||
<td></td> | <td></td> | ||
− | <td id="cardinality_cell"> | + | <td id="cardinality_cell">0..1</td> |
− | <td> | + | <td>Login-Token that ensures the user is logged in.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 62: | Zeile 57: | ||
<tr id="row_object"> | <tr id="row_object"> | ||
<td id="cardinality_cell">1</td> | <td id="cardinality_cell">1</td> | ||
− | <td id="param_level1"> | + | <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 129: | Zeile 124: | ||
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>Last change date of the entity version.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 136: | Zeile 131: | ||
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td>Point in time | + | <td>Point in time when entry was inserted.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 143: | Zeile 138: | ||
<td>Boolean</td> | <td>Boolean</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td>Indicates if | + | <td>Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. </td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 168: | Zeile 163: | ||
<tr> | <tr> | ||
<td id="cardinality_cell">3</td> | <td id="cardinality_cell">3</td> | ||
− | <td id="param_level3"> | + | <td id="param_level3">statusDeactivated</td> |
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Defines the state. Default value is 0 (=visible). Look for available values in the according domain.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">statusDeactivatedDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Date when statusDeactivated changed</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">statusVisibility</td> | ||
<td>Integer</td> | <td>Integer</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
Zeile 175: | Zeile 184: | ||
<tr> | <tr> | ||
<td id="cardinality_cell">3</td> | <td id="cardinality_cell">3</td> | ||
− | <td id="param_level3"> | + | <td id="param_level3">statusVisibilityDate</td> |
<td>java.util.Date</td> | <td>java.util.Date</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>Point of time of the last change of the status.</td> | <td>Point of time of the last change of the status.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">statusWorkflow</td> | ||
+ | <td>Integer</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>A workflow status, can be unique for each codesystem.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">3</td> | ||
+ | <td id="param_level3">statusWorkflowDate</td> | ||
+ | <td>java.util.Date</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Date when statusWorkflow changed</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 185: | Zeile 208: | ||
<td>Long</td> | <td>Long</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
− | <td> | + | <td>The ID of this entry.</td> |
</tr> | </tr> | ||
<tr id="row_object"> | <tr id="row_object"> | ||
Zeile 193: | Zeile 216: | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
<td>Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version</td> | <td>Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td id="cardinality_cell">4</td> | ||
+ | <td id="param_level4">codeSystemEntityVersionId</td> | ||
+ | <td>Long</td> | ||
+ | <td></td> <td id="cardinality_cell">1..1</td> | ||
+ | <td>Equates the versionId of code_system_entity_version</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Zeile 211: | Zeile 241: | ||
</tr> | </tr> | ||
</table> | </table> | ||
+ | =Beispiele= | ||
+ | ==SOAP== | ||
+ | ===List all association types=== | ||
+ | <source lang="xml"> | ||
+ | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> | ||
+ | <soapenv:Header/> | ||
+ | <soapenv:Body> | ||
+ | <sear:ListConceptAssociationTypes> | ||
+ | <parameter> | ||
+ | </parameter> | ||
+ | </sear:ListConceptAssociationTypes> | ||
+ | </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]] |
Version vom 22. Juli 2014, 08:54 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Lists all association types. There are general associations available for all code systems, but also associations available in specific code systems only.
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 | codeSystem | code_system | 0..1 | If a code system is listed, the information is used as a filter | |
2 | codeSystemVersion | code_system_version | 0..1 | Version of a Code System | |
3 | versionId | Long | 1..1 |
Response
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | returnInfos | ReturnType | 1..1 | Return information | |
2 | count | Integer | 1..1 | 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 | codeSystemEntity | code_system_entity | 0..N | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
2 | currentVersionId | Long | 1..1 | Current ID of code_system_entity_version. | |
2 | id | Long | 1..1 | ||
2 | codeSystemEntityVersion | code_system_entity_version | 1..N | code_system_entity_version is the superclass of every Concept and Association. | |
3 | effectiveDate | java.util.Date | 1..1 | Last change date of the entity version. | |
3 | insertTimestamp | java.util.Date | 1..1 | Point in time when entry was inserted. | |
3 | isLeaf | Boolean | 1..1 | Indicates if an element is leaf or not. Value will be set by a trigger and is therefore read only. | |
3 | majorRevision | Integer | 1..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
3 | minorRevision | Integer | 1..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
3 | previousVersionId | Long | 1..1 | Refers to the prior version, if there are more than one version. | |
3 | statusDeactivated | Integer | 1..1 | Defines the state. Default value is 0 (=visible). Look for available values in the according domain. | |
3 | statusDeactivatedDate | java.util.Date | 1..1 | Date when statusDeactivated changed | |
3 | statusVisibility | Integer | 1..1 | Status of the current entry. Can be taken from a domain. | |
3 | statusVisibilityDate | java.util.Date | 1..1 | Point of time of the last change of the status. | |
3 | statusWorkflow | Integer | 1..1 | A workflow status, can be unique for each codesystem. | |
3 | statusWorkflowDate | java.util.Date | 1..1 | Date when statusWorkflow changed | |
3 | versionId | Long | 1..1 | The ID of this entry. | |
3 | associationType | association_type | 1..1 | Displays the name of a association. Specialization of code_system_entity_version. The codeSystemEntityVersionId equates the versionId of code_system_entity_version | |
4 | codeSystemEntityVersionId | Long | 1..1 | Equates the versionId of code_system_entity_version | |
4 | forwardName | String | 50 | 1..1 | Name of association in normal reading direction (ID 1->2) |
4 | reverseName | String | 50 | 1..1 | Name of association in reversed reading direction (ID 2->1) |
Beispiele
SOAP
List all association types
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sear="http://search.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <sear:ListConceptAssociationTypes> <parameter> </parameter> </sear:ListConceptAssociationTypes> </soapenv:Body> </soapenv:Envelope>