WS-Beschreibung - Terminologieserver Authorization Login
Aus Termserver-CTS2
Inhaltsverzeichnis |
Functionality
Login to terminology server. As result a session ID will be delivered, that can be used for other services that requires login.
Prerequisites
Request/Response
Request
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| LoginType | LoginType | 1..1 | Login information | |
| password | String | 1..1 | The password must be given as a MD5 value. | |
| username | String | 1..1 | the username |
Response
| Parameter | Typ | Länge | Kardinalität | Beschreibung |
|---|---|---|---|---|
| ReturnType | ReturnType | 1..1 | Return information | |
| message | String | 1..1 | an additional message | |
| overallErrorCategory | 1..1 | INFO, WARN, ERROR | ||
| status | 1..1 | OK, FAILURE | ||
| LoginType | LoginType | 1..1 | Login information | |
| sessionID | String | 1..1 | The Session-ID is required for all services which manipulate data in the terminology server. It is also required to retrieve code systems with licences. | |
| username | String | 1..1 | the username | |
| term_user | term_user | 1..1 | Every user of the terminolgy server. User are needed for code system with licenses code system and for the insertion of new content. | |
| id | Long | 1..1 |
Annotations
Noteworthiness
Hints
Password has to be encoded with MD5-Hash (<password>MD5-Hash value of password</password>).
Examples
SOAP messages
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://authorization.ws.terminologie.fhdo.de/"> <soapenv:Header/> <soapenv:Body> <aut:Login> <parameter> <login> <password>afesdfsd3gsds</password> <!-- a MD5 hash value of a password --> <username>user1</username> </login> </parameter> </aut:Login> </soapenv:Body> </soapenv:Envelope>
