POST api/v1/locations/{locationId}/deviceStatus

Get Device status details will return Lock and security device status Equivalent SOAP API : GetDeviceStatus

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required

Body Parameters

Collection of DeviceTypeAndID

Name	Description	Type	Additional information
DeviceID		integer	None.
DeviceType		integer	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "DeviceID": 1,
    "DeviceType": 2
  },
  {
    "DeviceID": 1,
    "DeviceType": 2
  }
]

application/xml, text/xml

Sample:

<ArrayOfDeviceTypeAndID xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
  <DeviceTypeAndID>
    <DeviceID>1</DeviceID>
    <DeviceType>2</DeviceType>
  </DeviceTypeAndID>
  <DeviceTypeAndID>
    <DeviceID>1</DeviceID>
    <DeviceType>2</DeviceType>
  </DeviceTypeAndID>
</ArrayOfDeviceTypeAndID>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetDeviceStatusResult

Name	Type	Additional information
deviceInfo	DeviceStatusInfos	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "deviceInfo": {
    "lockInfo": {
      "LockID": 1,
      "LockName": "sample string 2",
      "LockState": 3,
      "DeviceStatus": 4,
      "DeviceType": 5
    },
    "securityInfo": {
      "DeviceID": 1,
      "SecurityStatus": 2
    }
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<GetDeviceStatusResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <deviceInfo>
    <lockInfo>
      <DeviceStatus>4</DeviceStatus>
      <DeviceType>5</DeviceType>
      <LockID>1</LockID>
      <LockName>sample string 2</LockName>
      <LockState>3</LockState>
    </lockInfo>
    <securityInfo>
      <DeviceID>1</DeviceID>
      <SecurityStatus>2</SecurityStatus>
    </securityInfo>
  </deviceInfo>
</GetDeviceStatusResult>