POST Device/Login

Device Login (typically from NEXA.DeviceController)

Request Information

URI Parameters

None.

Body Parameters

DeviceLoginLogout
NameDescriptionTypeAdditional information
DeviceId

Device Id / Name / User Name

 string

Max length: 50
IPAddress

Client IP address (Internal Network IP)

 string

Max length: 80

Request Formats

application/json, text/json

Sample: 
{
  "DeviceId": "sample string 1",
  "IPAddress": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200 OK / 401 Unauthorized

DeviceLoginResponse
NameDescriptionTypeAdditional information
DeviceId

Device Id / Name / User Name

 string

Max length: 50
PlayerName

Player Name

 string

Max length: 50
OrgId

Organisation Id / Unit Id

 integer

None.
OrgName

Organisation / Unit Name

 string

None.
ThemeFolder

Folder name of the associated theme

 string

None.
TemplateFileName

HTML template file name (which exists in VisualTemplate/ThemeFolder)

 string

None.
MessageText

Additional information if the reponse code is not 200 OK ie Licence count exceeded

 string

Max length: 255

Response Formats

application/json, text/json

Sample: 
{
  "DeviceId": "sample string 1",
  "PlayerName": "sample string 2",
  "OrgId": 3,
  "OrgName": "sample string 4",
  "ThemeFolder": "sample string 5",
  "TemplateFileName": "sample string 6",
  "MessageText": "sample string 7"
}