Terminologieserver - Administration - ExportCodeSystemContent
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= | ||
| + | Export whole code systems in given export format.<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">1..1</td> | <td id="cardinality_cell">1..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 57: | Zeile 52: | ||
<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">exportInfos</td> |
<td>ExportType</td> | <td>ExportType</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| Zeile 73: | Zeile 68: | ||
<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">exportParameter</td> |
<td>ExportParameterType</td> | <td>ExportParameterType</td> | ||
<td></td> <td id="cardinality_cell">0..1</td> | <td></td> <td id="cardinality_cell">0..1</td> | ||
| Zeile 114: | Zeile 109: | ||
<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 150: | Zeile 145: | ||
<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">exportInfos</td> |
<td>ExportType</td> | <td>ExportType</td> | ||
<td></td> <td id="cardinality_cell">1..1</td> | <td></td> <td id="cardinality_cell">1..1</td> | ||
| Zeile 180: | Zeile 175: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| + | =Beispiele= | ||
| + | ==SOAP== | ||
| + | ===Export example=== | ||
| + | <source lang="xml"> | ||
| + | <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> | ||
| + | </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, 12:53 Uhr
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> <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>
