POST api/device/register

Register a device

Request Information

Authentication

This method does not require authentication

URI Parameters

None.

Body Parameters

Device
NameDescriptionTypeAdditional information
DeviceId

string

None.
DeviceType

DeviceType

None.
OS

OS

None.

Request Formats

application/json, text/json

Sample: 
{
  "DeviceId": "sample string 1",
  "DeviceType": 0,
  "OS": 0
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Token
NameDescriptionTypeAdditional information
TokenType

Token Type

 TokenType

None.
AccessToken

Access Token

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TokenType": 0,
  "AccessToken": "sample string 1"
}

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 112: InvalidOperation
    (The operation is not valid., Conflict)
  • 113: WriteOperationFailed
    (The requested operation failed., Conflict)
  • 109: MissingRequiredJsonParameter
    (Invalid request format. A required parameter in the request body was not specified for this request., BadRequest)
  • 114: InvalidJsonParameterValue
    (Invalid request format. The value provided for one of the parameters in the request body was not in the correct format., BadRequest)
  • 101: InvalidCredentials
    (Unable to verify your credentials., Unauthorized)
  • 110: DisabledApplication
    (FirstService Residential has disabled access to this application., Unauthorized)
  • 111: DisabledDevice
    (FirstService Residential has disabled access to this device., Unauthorized)