POST api/lockapi/add?siteId={siteId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteId | globally unique identifier |
None. |
Body Parameters
LockViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
None. |
|
| name | string |
String length: inclusive between 0 and 100 |
|
| direction | string |
Required String length: inclusive between 0 and 2 |
|
| distribution_id | globally unique identifier |
None. |
|
| guard_id | globally unique identifier |
None. |
|
| active | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": "bce5e43b-d212-49a9-a15f-ad7792c1621d",
"name": "sample string 2",
"direction": "sample string 3",
"distribution_id": "6309c433-9106-45f5-918d-ee863f3194b9",
"guard_id": "b77c176b-5694-442a-9906-7a1135e8f0c8",
"active": true
}
application/xml, text/xml
Sample:
<lock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel"> <active>true</active> <direction>sample string 3</direction> <distribution_id>6309c433-9106-45f5-918d-ee863f3194b9</distribution_id> <guard_id>b77c176b-5694-442a-9906-7a1135e8f0c8</guard_id> <id>bce5e43b-d212-49a9-a15f-ad7792c1621d</id> <name>sample string 2</name> </lock>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
Sample:
"fd33f6eb-9bab-4aa6-afe2-1b1a8579e4d4"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">fd33f6eb-9bab-4aa6-afe2-1b1a8579e4d4</guid>