GET api/v1/users/devices/{deviceId}

[TC2.1+] Retrieves user information using a hashed user code.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
deviceId

The ID of the device (Panel ID).

integer

Required

Body Parameters

None.

Response Information

Resource Description

An object containing user details for VOD.

UserDetailsForVod
NameDescriptionTypeAdditional information
HashedUserCode

string

None.

TimeStamp

string

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "HashedUserCode": "sample string 1",
  "TimeStamp": "sample string 2",
  "ResultCode": 3,
  "ResultData": "sample string 4"
}

application/xml, text/xml

Sample:
<UserDetailsForVod xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">3</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 4</ResultData>
  <HashedUserCode>sample string 1</HashedUserCode>
  <TimeStamp>sample string 2</TimeStamp>
</UserDetailsForVod>