POST 17.0/database/keyhistory/list

Description

Retrieve a list of Key History

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 KeyHistoryUpdate
Name Description Type Additional information
ID

integer

None.
KeyID

integer

None.
SignedOutDate

date

None.
SignedOutUserID

integer

None.
ContactID

integer

None.
Status

byte

None.
ExpectedReturnDate

date

None.
ReturnedDate

date

None.
ReturnedUserID

integer

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "keyID": 1,
    "signedOutDate": "2025-01-09T20:10",
    "signedOutUserID": 1,
    "contactID": 1,
    "status": 64,
    "expectedReturnDate": "2025-01-09T20:10",
    "returnedDate": "2025-01-09T20:10",
    "returnedUserID": 1
  },
  {
    "id": 1,
    "keyID": 1,
    "signedOutDate": "2025-01-09T20:10",
    "signedOutUserID": 1,
    "contactID": 1,
    "status": 64,
    "expectedReturnDate": "2025-01-09T20:10",
    "returnedDate": "2025-01-09T20:10",
    "returnedUserID": 1
  }
]

application/xml, text/xml
Sample: 
<ArrayOfKeyHistoryUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <KeyHistoryUpdate>
    <ID>1</ID>
    <KeyID>1</KeyID>
    <SignedOutDate>2025-01-09T20:10:57.6280903+00:00</SignedOutDate>
    <SignedOutUserID>1</SignedOutUserID>
    <ContactID>1</ContactID>
    <Status>64</Status>
    <ExpectedReturnDate>2025-01-09T20:10:57.6280903+00:00</ExpectedReturnDate>
    <ReturnedDate>2025-01-09T20:10:57.6280903+00:00</ReturnedDate>
    <ReturnedUserID>1</ReturnedUserID>
  </KeyHistoryUpdate>
  <KeyHistoryUpdate>
    <ID>1</ID>
    <KeyID>1</KeyID>
    <SignedOutDate>2025-01-09T20:10:57.6280903+00:00</SignedOutDate>
    <SignedOutUserID>1</SignedOutUserID>
    <ContactID>1</ContactID>
    <Status>64</Status>
    <ExpectedReturnDate>2025-01-09T20:10:57.6280903+00:00</ExpectedReturnDate>
    <ReturnedDate>2025-01-09T20:10:57.6280903+00:00</ReturnedDate>
    <ReturnedUserID>1</ReturnedUserID>
  </KeyHistoryUpdate>
</ArrayOfKeyHistoryUpdate>