POST api/locations/{locationId}/AutomationDevices/{DeviceID}/Lock

Request Information

URI Parameters

Name	Description	Type	Additional information
DeviceID		integer	Required
locationId		string	None.

Body Parameters

LockAction

Name	Type	Additional information
ids	Collection of integer	None.
action	eLockAction	None.
state	integer	None.
userCode	string	None.

Request Formats

application/json, text/json

Sample:

{
  "action": 0,
  "state": 1,
  "userCode": "sample string 2",
  "ids": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<LockAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
  <action>unlock</action>
  <ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ids>
  <state>1</state>
  <userCode>sample string 2</userCode>
</LockAction>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LockControlResults

None.

Response Formats

application/json, text/json

Sample:

{}

application/xml, text/xml

Sample:

<LockControlResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models" />