WS-Beschreibung - Terminologieserver Administration ExportCodeSystemContent
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Exports a code system in given export format.
Prerequisites
Requires Login.
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| LoginType | LoginType | 1..1 | Login information | |
| sessionID | String | 1..1 | Session-ID from user (given by system) | |
| code_system | code_system | 1..1 | Name of codesystem. Each codesystem requires at least one version. | |
| id | Long | 1..1 | Internal ID = Primary Key of Code System | |
| code_system_version | code_system_version | 0..1 | Version of a Code System | |
| versionId | Long | 1..1 | ||
| ExportType | ExportType | 1..1 | Parameter for export | |
| formatId | Long | 1..1 | Format of data content.
ClaML: 193 CSV: 194 |
|
| ExportParameterType | ExportParameterType | 0..1 | Contains additional parameters for export. | |
| associationInfos | String | 1..1 | ||
| codeSystemInfos | Boolean | 1..1 | true, if additional information from a code system should be exported | |
| translations | Boolean | 1..1 | true, if translations should be exported |
Response
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| ReturnType | ReturnType | 1..1 | Return information | |
| count | Integer | 1..1 | number of results | |
| message | String | 1..1 | an additional message | |
| overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| status | 1..1 | OK, FAILURE | ||
| ExportType | ExportType | 1..1 | Parameter for export | |
| filecontent | byte[] | 0..1 | data content as a blob | |
| formatId | Long | 1..1 | Format of data content.
ClaML: 193 CSV: 194 |
|
| url | String | 0..1 | URL where exported data can be found |
Annotations
Noteworthiness
Hints
Examples
SOAP messages
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <adm:ExportCodeSystemContent> <parameter> <codeSystem> <id>7</id> <codeSystemVersions> <versionId>8</versionId> </codeSystemVersions> </codeSystem> <exportInfos> <formatId>193</formatId> </exportInfos> <exportParameter> <dateFrom>2010-01-01T00:00:00.0</dateFrom> </exportParameter> </parameter> </adm:ExportCodeSystemContent> </soapenv:Body> </soapenv:Envelope>
