POST login
Generate time limited token. Token expiration time is 20seconds
Request Information
Authorization
- Not required
Availability
- Method can be used
URI Parameters
None.
Body Parameters
LoginReq| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | RequestResult |
None. |
|
| UserLogin |
All registered user can ask the system for valid token by using user login name and api key. |
string |
Required |
| ApiKey |
All registered user can ask the system for valid token by using user login name and api key. |
string |
Required |
Request Formats
application/json
Sample:
{"Result":null,"UserLogin":"John.Doo","ApiKey":"hDn/LFXIPESM036W+s7VKg=="}
application/xml
Sample:
<Request> <UserLogin>John.Doo</UserLogin> <ApiKey>hDn/LFXIPESM036W+s7VKg==</ApiKey> </Request>
Response Information
Response Codes
| Http Code | Error Number | Description |
|---|---|---|
| 200 request succesfully done | 0 | success |
| 400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
| 401 unauthorized | 1003 | UserLogin or ApiKey are unknown |
| 401 unauthorized | 1004 | ApiKey is invalid |
| 415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported | |
| 500 internal error | Server exception description |
Resource Description
LoginResp| Name | Description | Type | Additional information |
|---|---|---|---|
| Token |
The unique token can be used to verify batch of requests. The token is valid [ExpireInSec] sec. |
string |
None. |
| ExpireInSec |
The actual token expiration time in sec. |
integer |
None. |
| ExpireDate |
The actual token expiration date (in UTC) |
date |
None. |
Response Formats
application/json
Sample:
{"Token":"a45a039c-eb31-46f1-9ece-88aa5ccfe22c","ExpireInSec":20,"ExpireDate":"\/Date(1770202477469)\/"}
application/xml
Sample:
<Response> <Token>a45a039c-eb31-46f1-9ece-88aa5ccfe22c</Token> <ExpireInSec>20</ExpireInSec> <ExpireDate>2026-02-04T10:54:37.4697503Z</ExpireDate> </Response>