POST api/v1/CreateSession

Creates session. Returns session id which must then be passed in http headers. After session is created, call SetUserRights (and get LockGroups before that if necessary to get a lockgroup_id)

Request Information

URI Parameters

None.

Body Parameters

CreateSessionParam

Name	Description	Type	Additional information
UserName	User name	string	None.
Password	Password	string	None.
CustomerCode	Customer code	string	None.
ApiKey	Public key provided to developers	string	None.
ApiSecret	Secret key provided to developers	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "CustomerCode": "sample string 3",
  "ApiKey": "sample string 4",
  "ApiSecret": "sample string 5"
}

application/xml, text/xml

Sample:

<IloParams.CreateSessionParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.ws.WebApi.Params">
  <ApiKey>sample string 4</ApiKey>
  <ApiSecret>sample string 5</ApiSecret>
  <CustomerCode>sample string 3</CustomerCode>
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</IloParams.CreateSessionParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateSessionResult

Name	Description	Type	Additional information
SessionID	Created session ID.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SessionID": "sample string 1"
}

application/xml, text/xml

Sample:

<IloParams.CreateSessionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.ws.WebApi.Params">
  <SessionID>sample string 1</SessionID>
</IloParams.CreateSessionResult>