Terminologieserver - Authoring - CreateConceptAssociationType
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= | ||
| + | Create a new association type. | ||
| + | |||
| + | If a code system is specified, the new association type will be available in that code system only. Otherwise it will be available in all code systems.<br> | ||
=Request/Response= | =Request/Response= | ||
==Request== | ==Request== | ||
| Zeile 81: | Zeile 85: | ||
<td>association_type</td> | <td>association_type</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| − | <td> | + | <td>Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as the versionId of code_system_entity_version</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Zeile 113: | Zeile 117: | ||
<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 176: | Zeile 180: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| + | =Beispiele= | ||
| + | ==SOAP== | ||
| + | ===Create new association without relation to a code system=== | ||
| + | <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:CreateConceptAssociationType> | ||
| + | <parameter> | ||
| + | <codeSystemEntity> | ||
| + | <codeSystemEntityVersions> | ||
| + | <associationTypes> | ||
| + | <forwardName>Vor</forwardName> | ||
| + | <reverseName>Zurück</reverseName> | ||
| + | </associationTypes> | ||
| + | </codeSystemEntityVersions> | ||
| + | </codeSystemEntity> | ||
| + | <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> | ||
| + | </parameter> | ||
| + | </aut:CreateConceptAssociationType> | ||
| + | </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 23. Juli 2014, 10:09 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Create a new association type.
If a code system is specified, the new association type will be available in that code system only. Otherwise it will be available in all code systems.
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 | codeSystem | code_system | 0..1 | Name of codesystem. Each codesystem requires at least one version. | |
| 2 | id | Long | 1..1 | Internal ID = Primary Key of Code System | |
| 2 | codeSystemVersion | code_system_version | 1..1 | Version of a Code System | |
| 3 | versionId | Long | 1..1 | ||
| 1 | codeSystemEntity | code_system_entity | 1..1 | Abstract class. Every entry in code_system_entity requires at least one entry in code_system_entity_version. | |
| 2 | codeSystemEntityVersion | code_system_entity_version | 1..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | majorRevision | Integer | 0..1 | Major revision of this entry (composition of major and minor version e.g. 1.3). | |
| 3 | minorRevision | Integer | 0..1 | Minor revision of this entry (composition of major and minor version e.g. 1.3) | |
| 3 | associationType | association_type | 1..1 | Name of an association. Specialization of code_system_entity_version. The codeSystemEntityVersionId is the same as 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) |
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 | ||
| 1 | codeSystemEntity | code_system_entity | 1..1 | 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..1 | code_system_entity_version is the superclass of every Concept and Association. | |
| 3 | versionId | Long | 1..1 | The ID of this entry. |
Beispiele
SOAP
Create new association without relation to a code system
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:CreateConceptAssociationType> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <associationTypes> <forwardName>Vor</forwardName> <reverseName>Zurück</reverseName> </associationTypes> </codeSystemEntityVersions> </codeSystemEntity> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </aut:CreateConceptAssociationType> </soapenv:Body> </soapenv:Envelope>
