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>

text/json

Sample:

{
  "Result": {
    "Message": "sample string 1",
    "Code": 2,
    "ModelStateErr": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "UserLogin": "sample string 1",
  "ApiKey": "sample string 2"
}

text/xml

Sample:

<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>
    <Message>sample string 1</Message>
    <Code>2</Code>
    <ModelStateErr>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </ModelStateErr>
  </Result>
  <UserLogin>sample string 1</UserLogin>
  <ApiKey>sample string 2</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.

Response Formats

application/json

Sample:

{"Token":"ceb49f03-4ddf-424e-8abb-ff37bb9a8bc7","ExpireInSec":20}

application/xml

Sample:


<Response>
  <Token>ceb49f03-4ddf-424e-8abb-ff37bb9a8bc7</Token>
  <ExpireInSec>20</ExpireInSec>
</Response>

text/json

Sample:

{
  "Token": "sample string 1",
  "ExpireInSec": 2
}

text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Token>sample string 1</Token>
  <ExpireInSec>2</ExpireInSec>
</Response>