GET api/lockapi/locksbydistribution/{distributionId}?active={active}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| distributionId | globally unique identifier |
Required |
|
| active | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of 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. |
Response Formats
application/json, text/json
Sample:
[
{
"id": "4dded667-737c-4180-85d9-25d7563bbddd",
"name": "sample string 2",
"direction": "sample string 3",
"distribution_id": "276def5e-f81d-49d4-be42-0f4ef1185b79",
"guard_id": "78a569a6-3558-4447-9003-dcf855e2aa10",
"active": true
},
{
"id": "4dded667-737c-4180-85d9-25d7563bbddd",
"name": "sample string 2",
"direction": "sample string 3",
"distribution_id": "276def5e-f81d-49d4-be42-0f4ef1185b79",
"guard_id": "78a569a6-3558-4447-9003-dcf855e2aa10",
"active": true
}
]
application/xml, text/xml
Sample:
<ArrayOflock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
<lock>
<active>true</active>
<direction>sample string 3</direction>
<distribution_id>276def5e-f81d-49d4-be42-0f4ef1185b79</distribution_id>
<guard_id>78a569a6-3558-4447-9003-dcf855e2aa10</guard_id>
<id>4dded667-737c-4180-85d9-25d7563bbddd</id>
<name>sample string 2</name>
</lock>
<lock>
<active>true</active>
<direction>sample string 3</direction>
<distribution_id>276def5e-f81d-49d4-be42-0f4ef1185b79</distribution_id>
<guard_id>78a569a6-3558-4447-9003-dcf855e2aa10</guard_id>
<id>4dded667-737c-4180-85d9-25d7563bbddd</id>
<name>sample string 2</name>
</lock>
</ArrayOflock>