Terminologieserver - Administration - MaintainDomain
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= | ||
| + | Edit domains and/or domain values. <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 186: | Zeile 181: | ||
<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 221: | Zeile 216: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| + | =Beispiele= | ||
| + | ==SOAP== | ||
| + | ===Maintain domain=== | ||
| + | <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:MaintainDomain> | ||
| + | <parameter> | ||
| + | <domain> | ||
| + | <description>Gültigkeitsbereiche im System</description> | ||
| + | <domainId>2</domainId> | ||
| + | <domainName>Validity Domain</domainName> | ||
| + | </domain> | ||
| + | <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> | ||
| + | </parameter> | ||
| + | </adm:MaintainDomain> | ||
| + | </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]] | ||
Aktuelle Version vom 22. Juli 2014, 12:54 Uhr
zurück zur Webservice-Übersicht
Inhaltsverzeichnis |
Beschreibung
Edit domains and/or domain values.
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 | domain | domain | 1..1 | List of all available domains (lists of values). | |
| 2 | defaultValue | String | 60 | 0..1 | Default value, has to be taken from the table domain_value and the attribute 'code' |
| 2 | description | String | 65535 | 0..1 | Description of the domain. |
| 2 | displayOrder | Long | 0..1 | Order of display of the values. The ID has to be chosen from the domain with the ID 3 'Display Order'. Possible values on the terminolgy server are ID 185 - to ID, ID 186 - to Order-Number, ID 187 - to name | |
| 2 | displayText | String | 65535 | 0..1 | Name of the domain that should be shown. |
| 2 | domainId | Long | 1..1 | ||
| 2 | domainName | String | 50 | 0..1 | Name of the domain (e.g. country codes) |
| 2 | domainOid | String | 50 | 0..1 | OID of the domain, if existing. |
| 2 | domainType | String | 50 | 0..1 | |
| 2 | isOptional | Boolean | 0..1 | ||
| 2 | domainValue | domain_value | 0..N | Value from a domain. | |
| 3 | attribut1Classname | String | 50 | 0..1 | Additonal information |
| 3 | attribut1Value | String | 50 | 0..1 | Additonal information |
| 3 | domainCode | String | 50 | 0..1 | Code of the value. It is used as foreign key. |
| 3 | domainDisplay | String | 100 | 0..1 | Displayed name of the value. |
| 3 | domainId | Long | 0..1 | ||
| 3 | domainValueId | Long | 1..1 | ||
| 3 | imageFile | String | 65535 | 0..1 | Filename of an image saved on the file system. |
| 3 | orderNo | Integer | 0..1 | Manual order of the values. The 'displayOrder' of the domain in the table 'domain' with 186 (to Order-Number) has to be used. |
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 |
Beispiele
SOAP
Maintain domain
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://administration.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <adm:MaintainDomain> <parameter> <domain> <description>Gültigkeitsbereiche im System</description> <domainId>2</domainId> <domainName>Validity Domain</domainName> </domain> <loginToken>237b6ee6-a448-4b91-8210-a896bf50258a</loginToken> </parameter> </adm:MaintainDomain> </soapenv:Body> </soapenv:Envelope>
