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": "8c0d1b54-1c02-462b-ab4e-8a78963992af",
"name": "sample string 2",
"direction": "sample string 3",
"distribution_id": "5e920263-496c-47ef-a98e-bad20c9d4f21",
"guard_id": "e97d9bad-dc1b-4829-8684-521f55d6d1d7",
"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>5e920263-496c-47ef-a98e-bad20c9d4f21</distribution_id> <guard_id>e97d9bad-dc1b-4829-8684-521f55d6d1d7</guard_id> <id>8c0d1b54-1c02-462b-ab4e-8a78963992af</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:
"9a6c181d-2d12-4158-a246-720ba316b2a3"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">9a6c181d-2d12-4158-a246-720ba316b2a3</guid>