POST 17.0/database/keys/list

Description

Retrieve a list of Keys

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of KeysUpdate
Name Description Type Additional information
ID

integer

None.
PropertyID

integer

None.
Reference

string

String length: inclusive between 0 and 10
Notes

string

None.
Status

byte

None.
UpdatedDate

date

None.
CardID

string

String length: inclusive between 0 and 50
InActive

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "propertyID": 1,
    "reference": "sample string 1",
    "notes": "sample string 2",
    "status": 64,
    "updatedDate": "2025-01-09T20:50",
    "cardID": "sample string 3",
    "inActive": 64
  },
  {
    "id": 1,
    "propertyID": 1,
    "reference": "sample string 1",
    "notes": "sample string 2",
    "status": 64,
    "updatedDate": "2025-01-09T20:50",
    "cardID": "sample string 3",
    "inActive": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfKeysUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <KeysUpdate>
    <ID>1</ID>
    <PropertyID>1</PropertyID>
    <Reference>sample string 1</Reference>
    <Notes>sample string 2</Notes>
    <Status>64</Status>
    <UpdatedDate>2025-01-09T20:50:00.1335046+00:00</UpdatedDate>
    <CardID>sample string 3</CardID>
    <InActive>64</InActive>
  </KeysUpdate>
  <KeysUpdate>
    <ID>1</ID>
    <PropertyID>1</PropertyID>
    <Reference>sample string 1</Reference>
    <Notes>sample string 2</Notes>
    <Status>64</Status>
    <UpdatedDate>2025-01-09T20:50:00.1335046+00:00</UpdatedDate>
    <CardID>sample string 3</CardID>
    <InActive>64</InActive>
  </KeysUpdate>
</ArrayOfKeysUpdate>