GET api/property/{id}/keys

Get a list of keys for a property

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The Id of the property	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Dezrez.Core.DataContracts.External.Api.Property.Query.Get.PropertyKeyDataContract

Name	Type	Additional information
Name	string	None.
Code	string	None.
IsCheckedOut	boolean	None.
IsPermanent	boolean	None.
CheckedInAt	date	None.
CheckedInBy	Dezrez.Core.DataContracts.External.Api.Property.Query.Keys.KeyNegotiatorDataContract	None.
NoteOnCheckIn	string	None.
CheckedOutAt	date	None.
CheckedOutBy	Dezrez.Core.DataContracts.External.Api.Property.Query.Keys.KeyNegotiatorDataContract	None.
NoteOnCheckOut	string	None.
RecipientDetails	Dezrez.Core.DataContracts.External.Api.Property.Query.Keys.KeyRecipientDetailsDataContract	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "Code": "sample string 2",
    "IsCheckedOut": true,
    "IsPermanent": true,
    "CheckedInAt": "2024-04-25T07:35:21.7143546Z",
    "CheckedInBy": {
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 4",
      "Id": 5
    },
    "NoteOnCheckIn": "sample string 5",
    "CheckedOutAt": "2024-04-25T07:35:21.7143546Z",
    "CheckedOutBy": {
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 4",
      "Id": 5
    },
    "NoteOnCheckOut": "sample string 6",
    "RecipientDetails": {
      "RecipientId": 1,
      "RecipientName": "sample string 2",
      "RecipientGroupName": "sample string 3",
      "RecipientType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    },
    "Id": 7
  },
  {
    "Name": "sample string 1",
    "Code": "sample string 2",
    "IsCheckedOut": true,
    "IsPermanent": true,
    "CheckedInAt": "2024-04-25T07:35:21.7143546Z",
    "CheckedInBy": {
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 4",
      "Id": 5
    },
    "NoteOnCheckIn": "sample string 5",
    "CheckedOutAt": "2024-04-25T07:35:21.7143546Z",
    "CheckedOutBy": {
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 4",
      "Id": 5
    },
    "NoteOnCheckOut": "sample string 6",
    "RecipientDetails": {
      "RecipientId": 1,
      "RecipientName": "sample string 2",
      "RecipientGroupName": "sample string 3",
      "RecipientType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    },
    "Id": 7
  }
]