Terminologieserver - Administration - ExportCodeSystemContent
Aus Termserver-CTS2
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Export whole code systems in given export format.
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 | 1..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 | 0..1 | Version of a Code System | |
| 3 | versionId | Long | 1..1 | ||
| 1 | exportInfos | ExportType | 1..1 | Parameter for export | |
| 2 | formatId | Long | 1..1 | Format of data content.
ClaML: 193 CSV: 194 |
|
| 1 | exportParameter | ExportParameterType | 0..1 | Contains additional parameters for export. | |
| 2 | associationInfos | String | 1..1 | ||
| 2 | codeSystemInfos | Boolean | 1..1 | true, if additional information from a code system should be exported | |
| 2 | translations | Boolean | 1..1 | true, if translations should be exported |
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 | exportInfos | ExportType | 1..1 | Parameter for export | |
| 2 | filecontent | byte[] | 0..1 | data content as a blob | |
| 2 | formatId | Long | 1..1 | Format of data content.
ClaML: 193 CSV: 194 |
|
| 2 | url | String | 0..1 | URL where exported data can be found |
Beispiele
SOAP
Export example
<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> <codeSystemVersions> <versionId>8</versionId> </codeSystemVersions> <id>7</id> </codeSystem> <exportInfos> <formatId>193</formatId> </exportInfos> <exportParameter> <dateFrom>2010-01-01T00:00:00.0</dateFrom> </exportParameter> </parameter> </adm:ExportCodeSystemContent> </soapenv:Body> </soapenv:Envelope>
