POST api/v1/account/status/{statusOnly}/syncusers
[TC2.1+] Synchronize Total Connect Users with Security System user codes Equivalent SOAP API: SynchronizePanelUser
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
statusOnly |
Location ID |
boolean |
Required |
Body Parameters
Collection of DeviceAuthorizingCodeName | Description | Type | Additional information |
---|---|---|---|
LocationID | integer |
None. |
|
DeviceID | integer |
None. |
|
AuthorizingCode | string |
None. |
Request Formats
application/json, text/json
Sample:
[ { "LocationID": 1, "DeviceID": 2, "AuthorizingCode": "sample string 3" }, { "LocationID": 1, "DeviceID": 2, "AuthorizingCode": "sample string 3" } ]
application/xml, text/xml
Sample:
<ArrayOfDeviceAuthorizingCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.UserConfiguration"> <DeviceAuthorizingCode> <AuthorizingCode>sample string 3</AuthorizingCode> <DeviceID>2</DeviceID> <LocationID>1</LocationID> </DeviceAuthorizingCode> <DeviceAuthorizingCode> <AuthorizingCode>sample string 3</AuthorizingCode> <DeviceID>2</DeviceID> <LocationID>1</LocationID> </DeviceAuthorizingCode> </ArrayOfDeviceAuthorizingCode>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SynchronizeUserResults
SynchronizeUserResultsName | Description | Type | Additional information |
---|---|---|---|
SynchronizationStatus | Collection of SyncStatus |
None. |
|
ResultCode | integer |
None. |
|
ResultData | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "SynchronizationStatus": [ { "DeviceID": 1, "DeviceName": "sample string 2", "TotalSteps": 3, "CurrentStep": 4, "Description": "sample string 5", "StatusText": "sample string 6", "ResultCode": 7, "ResultData": "sample string 8" }, { "DeviceID": 1, "DeviceName": "sample string 2", "TotalSteps": 3, "CurrentStep": 4, "Description": "sample string 5", "StatusText": "sample string 6", "ResultCode": 7, "ResultData": "sample string 8" } ], "ResultCode": 1, "ResultData": "sample string 2" }
application/xml, text/xml
Sample:
<SynchronizeUserResults 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">1</ResultCode> <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData> <SynchronizationStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.UserConfiguration"> <d2p1:SyncStatus> <d2p1:AdditionalInfo>sample string 9</d2p1:AdditionalInfo> <d2p1:CurrentStep>4</d2p1:CurrentStep> <d2p1:Description>sample string 5</d2p1:Description> <d2p1:DeviceID>1</d2p1:DeviceID> <d2p1:DeviceName>sample string 2</d2p1:DeviceName> <d2p1:ResultCode>7</d2p1:ResultCode> <d2p1:ResultData>sample string 8</d2p1:ResultData> <d2p1:StatusText>sample string 6</d2p1:StatusText> <d2p1:TotalSteps>3</d2p1:TotalSteps> </d2p1:SyncStatus> <d2p1:SyncStatus> <d2p1:AdditionalInfo>sample string 9</d2p1:AdditionalInfo> <d2p1:CurrentStep>4</d2p1:CurrentStep> <d2p1:Description>sample string 5</d2p1:Description> <d2p1:DeviceID>1</d2p1:DeviceID> <d2p1:DeviceName>sample string 2</d2p1:DeviceName> <d2p1:ResultCode>7</d2p1:ResultCode> <d2p1:ResultData>sample string 8</d2p1:ResultData> <d2p1:StatusText>sample string 6</d2p1:StatusText> <d2p1:TotalSteps>3</d2p1:TotalSteps> </d2p1:SyncStatus> </SynchronizationStatus> </SynchronizeUserResults>