Terminologieserver - Authoring - UpdateConceptStatus
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Update the status of a concept (code system entity version).
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 | 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 | statusDeactivated | Integer | 0..1 | Defines the state. Default value is 0 (=visible). Look for available values in the according domain. | |
| 3 | statusVisibility | Integer | 0..1 | Status of the current entry. Can be taken from a domain. | |
| 3 | statusWorkflow | Integer | 0..1 | A workflow status, can be unique for each codesystem. | |
| 3 | versionId | Long | 1..1 | The ID of this entry. |
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
Update status
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authoring.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:UpdateConceptStatus> <parameter> <codeSystemEntity> <codeSystemEntityVersions> <versionId>4</versionId> <statusVisibility>1</statusVisibility> <statusWorkflow>3</statusWorkflow> </codeSystemEntityVersions> </codeSystemEntity> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </aut:UpdateConceptStatus> </soapenv:Body> </soapenv:Envelope>
