POST api/v100/deviceSessions

Get a new SessionTK for the user.

Request Information

URI Parameters

None.

Headers

NameDescriptionTypeAdditional information
appkey

Ej. abcdefghijk

None.

session

Ej. 1234567890

None.

Body Parameters

RqSessionTK
NameDescriptionTypeAdditional information
FKAppGroup

FK AppGroup

integer

None.

password

Password or userGuid of the user.

string

None.

email

Email of the users

string

None.

deviceID

Platform Dependent Device Identifier (IMEI, Serial Number, etc.)

string

Required

String length: inclusive between 1 and 50

devicePlatform

Device Platform

string

Required

String length: inclusive between 1 and 50

deviceName

Device Name

string

Required

String length: inclusive between 1 and 50

keepAlive

User can require the session not to be closed due to timeout.

boolean

Required

apiKey

API Key to store.

string

Required

otherInfo

Optional debug info in case there is a problem. e.g. Phone Build date, Carrier, etc.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FKAppGroup": 1,
  "password": "sample string 1",
  "email": "sample string 2",
  "deviceID": "sample string 3",
  "devicePlatform": "sample string 4",
  "deviceName": "sample string 5",
  "keepAlive": true,
  "apiKey": "sample string 7",
  "otherInfo": "sample string 8"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RqSessionTK'.

Response Information

Resource Description

RsSessionTK
NameDescriptionTypeAdditional information
sessionTK

Session Token.

string

Required

userGuid

User Identifier for future communications.

string

Required

Response Formats

application/json, text/json

Sample:
{
  "sessionTK": "sample string 1",
  "userGuid": "sample string 2"
}