POST api/lockapi/add?siteId={siteId}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId		globally unique identifier	None.

Body Parameters

LockViewModel

Name	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": "1722c569-4e8c-478b-807b-93fcabd25fd2",
  "name": "sample string 2",
  "direction": "sample string 3",
  "distribution_id": "e12e63ad-9bfa-4424-9ccb-f83876a930c2",
  "guard_id": "8e4fd611-81e8-44cb-b2b2-753767b639cf",
  "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>e12e63ad-9bfa-4424-9ccb-f83876a930c2</distribution_id>
  <guard_id>8e4fd611-81e8-44cb-b2b2-753767b639cf</guard_id>
  <id>1722c569-4e8c-478b-807b-93fcabd25fd2</id>
  <name>sample string 2</name>
</lock>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LockViewModel'.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"81ed6f96-00dc-495f-95cd-8c81bc5de6a3"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">81ed6f96-00dc-495f-95cd-8c81bc5de6a3</guid>