GET api/key/all?pageSize={pageSize}&pageNumber={pageNumber}

Gets a summary of all keys in an agency.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 20

pageNumber

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfGetKeysDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of GetKeysDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Property": {
        "Address": {
          "OrganizationName": "sample string 1",
          "Number": "sample string 2",
          "BuildingName": "sample string 3",
          "Street": "sample string 4",
          "Town": "sample string 5",
          "Locality": "sample string 6",
          "County": "sample string 7",
          "Postcode": "sample string 8",
          "Id": 9
        },
        "Roles": [
          {
            "Id": 1,
            "Name": "sample string 2",
            "RoleType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "RoleStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "OwningBranch": {
              "Id": 1,
              "Name": "sample string 1"
            }
          },
          {
            "Id": 1,
            "Name": "sample string 2",
            "RoleType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "RoleStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "OwningBranch": {
              "Id": 1,
              "Name": "sample string 1"
            }
          }
        ],
        "Id": 1
      },
      "Name": "sample string 1",
      "Code": "sample string 2",
      "IsCheckedOut": true,
      "IsPermanent": true,
      "CheckedInAt": "2020-12-02T13:30:29.5690849Z",
      "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": "2020-12-02T13:30:29.5690849Z",
      "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
    },
    {
      "Property": {
        "Address": {
          "OrganizationName": "sample string 1",
          "Number": "sample string 2",
          "BuildingName": "sample string 3",
          "Street": "sample string 4",
          "Town": "sample string 5",
          "Locality": "sample string 6",
          "County": "sample string 7",
          "Postcode": "sample string 8",
          "Id": 9
        },
        "Roles": [
          {
            "Id": 1,
            "Name": "sample string 2",
            "RoleType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "RoleStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "OwningBranch": {
              "Id": 1,
              "Name": "sample string 1"
            }
          },
          {
            "Id": 1,
            "Name": "sample string 2",
            "RoleType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "RoleStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "OwningBranch": {
              "Id": 1,
              "Name": "sample string 1"
            }
          }
        ],
        "Id": 1
      },
      "Name": "sample string 1",
      "Code": "sample string 2",
      "IsCheckedOut": true,
      "IsPermanent": true,
      "CheckedInAt": "2020-12-02T13:30:29.5690849Z",
      "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": "2020-12-02T13:30:29.5690849Z",
      "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
    }
  ]
}