POST Login

Login to the API, This will provide a session_id that will need to passed into all the other API end points.

Request Information

URI Parameters

None.

Body Parameters

LoginHelperModel
NameDescriptionTypeAdditional information
username

string

None.
password

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "username": "sample string 1",
  "password": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

replyLogin
NameDescriptionTypeAdditional information
session_id

string

None.
source_id

integer

None.
status

integer

None.
message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "session_id": "sample string 1",
  "source_id": 2,
  "status": 3,
  "message": "sample string 4"
}