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": "46fa8398-1f2a-4efd-859f-728bd0ef543a",
"name": "sample string 2",
"direction": "sample string 3",
"distribution_id": "f0ab1478-b8d7-474d-942e-9657f52e05c4",
"guard_id": "895a48c5-7734-4b07-9597-049dfa4b4041",
"active": true
},
{
"id": "46fa8398-1f2a-4efd-859f-728bd0ef543a",
"name": "sample string 2",
"direction": "sample string 3",
"distribution_id": "f0ab1478-b8d7-474d-942e-9657f52e05c4",
"guard_id": "895a48c5-7734-4b07-9597-049dfa4b4041",
"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>f0ab1478-b8d7-474d-942e-9657f52e05c4</distribution_id>
<guard_id>895a48c5-7734-4b07-9597-049dfa4b4041</guard_id>
<id>46fa8398-1f2a-4efd-859f-728bd0ef543a</id>
<name>sample string 2</name>
</lock>
<lock>
<active>true</active>
<direction>sample string 3</direction>
<distribution_id>f0ab1478-b8d7-474d-942e-9657f52e05c4</distribution_id>
<guard_id>895a48c5-7734-4b07-9597-049dfa4b4041</guard_id>
<id>46fa8398-1f2a-4efd-859f-728bd0ef543a</id>
<name>sample string 2</name>
</lock>
</ArrayOflock>