POST 17.0/app/keys/list

Description

Gets all property keys that match the passed filters

URI Parameters

None.

Filters to retrieve keys for

KeyListFilters
Name Description Type Additional information
Status

KeyListStatus

None.
Branches

Collection of integer

None.
Categories

Collection of integer

None.
ManagementTypes

Collection of integer

None.
PropertyId

integer

None.

application/json, text/json
Sample: 
{
  "status": 0,
  "branches": [
    1,
    2
  ],
  "categories": [
    1,
    2
  ],
  "managementTypes": [
    1,
    2
  ],
  "propertyId": 1
}

application/xml, text/xml
Sample: 
<KeyListFilters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Status>Available</Status>
  <Branches>
    <int>1</int>
    <int>2</int>
  </Branches>
  <Categories>
    <int>1</int>
    <int>2</int>
  </Categories>
  <ManagementTypes>
    <int>1</int>
    <int>2</int>
  </ManagementTypes>
  <PropertyId>1</PropertyId>
</KeyListFilters>

application/x-www-form-urlencoded
Sample:

Sample not available.

Array of Key List Items

Collection of KeyListItem
Name Description Type Additional information
Id

integer

None.
Reference

string

None.
Property

string

None.
Owner

string

None.
Status

IDDescriptionPair

None.
Notes

string

None.
Contact

string

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "reference": "sample string 2",
    "property": "sample string 3",
    "owner": "sample string 4",
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "notes": "sample string 5",
    "contact": "sample string 6"
  },
  {
    "id": 1,
    "reference": "sample string 2",
    "property": "sample string 3",
    "owner": "sample string 4",
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "notes": "sample string 5",
    "contact": "sample string 6"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfKeyListItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <KeyListItem>
    <Id>1</Id>
    <Reference>sample string 2</Reference>
    <Property>sample string 3</Property>
    <Owner>sample string 4</Owner>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Notes>sample string 5</Notes>
    <Contact>sample string 6</Contact>
  </KeyListItem>
  <KeyListItem>
    <Id>1</Id>
    <Reference>sample string 2</Reference>
    <Property>sample string 3</Property>
    <Owner>sample string 4</Owner>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <Notes>sample string 5</Notes>
    <Contact>sample string 6</Contact>
  </KeyListItem>
</ArrayOfKeyListItem>