Login Service

The various details of the Login REST services are explained in this section. You must specify the username, password, and enterprise name as a request JSON body. You can send the parameters either in the request body or as a query parameter. If both the parameters are specified, the body parameters are used to login.

HTTP Method
Endpoint URL See Endpoint
Resource /login/userinfo
Request Parameters Specify the following parameters:
Name Description Type Data Type
Required
username Name of the user query string
password password query string
enterprise Name of the enterprise query string
Note: Either request body or query parameters are required. If both are specified, the body parameters are used.
Media Type application/json
Request Model 
{
  "username": "string",
  "password": "string",
  "enterprise": "string"
}
Response Model 
{
  "sessionId": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "result": {
    "severity": "string",
    "code": "string",
    "description": {
      "lang": "string",
      "message": "string"
    }
  }
}
Request Example A username is 14305_1 and password is xyr62dwUuk4= is the enterprise named "Company": 
{  
   "username":"14305_1",
   "password":"xyr62dwUuk4=",
   "enterprise":"Company"
}
Response Example The response returns the message that the login was successfully. 
{
"sessionId": "gHVYMHNScidvq2SPevK8+GRp.undefined",
"errorCode": "",
"errorMessage": "",
"result": {
"severity": "Info",
"code": "SVC-11219",
"description": {
"lang": "English",
"message": "Login successful."
    }
  }
}
Success Response Example:

Code: 200 successful operation

Error Response If the response is unsuccessful, either of the following error code is displayed:

Example:

Code: 400 Parameters required are missing

OR

Code: 404 User not found

OR

Code: 500 Internal error occurred

For error code response, see Error Handling .