GET api/lockapi/locksbycustomer/{customerId}?active={active}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

globally unique identifier

Required

active

boolean

None.

Body Parameters

None.

Response Information

Resource Description

Collection of LockViewModel
NameDescriptionTypeAdditional 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": "dcafc214-d3ac-400a-b773-6ce9e2c075ee",
    "name": "sample string 2",
    "direction": "sample string 3",
    "distribution_id": "c43f4ad2-2f3b-464e-ad9f-fc28beabbe7d",
    "guard_id": "f98f687c-5cd8-41b2-8d44-ed2137f6492e",
    "active": true
  },
  {
    "id": "dcafc214-d3ac-400a-b773-6ce9e2c075ee",
    "name": "sample string 2",
    "direction": "sample string 3",
    "distribution_id": "c43f4ad2-2f3b-464e-ad9f-fc28beabbe7d",
    "guard_id": "f98f687c-5cd8-41b2-8d44-ed2137f6492e",
    "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>c43f4ad2-2f3b-464e-ad9f-fc28beabbe7d</distribution_id>
    <guard_id>f98f687c-5cd8-41b2-8d44-ed2137f6492e</guard_id>
    <id>dcafc214-d3ac-400a-b773-6ce9e2c075ee</id>
    <name>sample string 2</name>
  </lock>
  <lock>
    <active>true</active>
    <direction>sample string 3</direction>
    <distribution_id>c43f4ad2-2f3b-464e-ad9f-fc28beabbe7d</distribution_id>
    <guard_id>f98f687c-5cd8-41b2-8d44-ed2137f6492e</guard_id>
    <id>dcafc214-d3ac-400a-b773-6ce9e2c075ee</id>
    <name>sample string 2</name>
  </lock>
</ArrayOflock>