Terminologieserver - Administration - MaintainDomain
Aus Termserver-CTS2
Version vom 22. Juli 2014, 07:27 Uhr von Muetzner (Diskussion | Beiträge)
zurück zur Webservice-Übersicht
Request/Response
Request
Level | Parameter | Typ | Länge | Kardinalität | Beschreibung |
---|---|---|---|---|---|
1 | LoginType | LoginType | 1..1 | Login information | |
2 | sessionID | String | 1..1 | Session-ID from user (given by system) | |
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 | ReturnType | 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 |