GET v1/agentdata/keybooks?FromUTC={FromUTC}&ToUTC={ToUTC}&PageNo={PageNo}&XMLAgentID={XMLAgentID}

Request Information

URI Parameters

Name	Type	Additional information
FromUTC	date	None.
ToUTC	date	None.
PageNo	integer	None.
XMLAgentID	string	None.

Body Parameters

None.

Response Information

Resource Description

KeyBookData

Name	Type	Additional information
RequestedData	string	None.
Options	KeyBookOptions	None.
RecordCount	integer	None.
DataRecords	Collection of KeyBook	None.

Response Formats

application/json, text/json

Sample:

{
  "RequestedData": "sample string 1",
  "Options": {
    "FromUTC": "2025-10-25T14:43:43.9238701+00:00",
    "ToUTC": "2025-10-25T14:43:43.9238701+00:00",
    "PageNo": 3,
    "XMLAgentID": "sample string 4"
  },
  "RecordCount": 2,
  "DataRecords": [
    {
      "AgentName": "sample string 1",
      "KeyImageURL": "sample string 2",
      "KeyNumber": "sample string 3",
      "StreetNo": "sample string 4",
      "Street": "sample string 5",
      "Suburb": "sample string 6",
      "PostCode": "sample string 7",
      "Listed": true,
      "PropertyManager": "sample string 9",
      "ListingAgent": "sample string 10",
      "DateBorrowedUTC": "2025-10-25T14:43:43.9238701+00:00",
      "DueBackDateUTC": "2025-10-25T14:43:43.9238701+00:00",
      "DateReturnedUTC": "2025-10-25T14:43:43.9238701+00:00",
      "ProcessedBy": "sample string 14",
      "BorrowerType": "sample string 15",
      "StaffLoan": "sample string 16",
      "Company": "sample string 17",
      "Mobile": "sample string 18",
      "Email": "sample string 19",
      "BookingReason": "sample string 20"
    },
    {
      "AgentName": "sample string 1",
      "KeyImageURL": "sample string 2",
      "KeyNumber": "sample string 3",
      "StreetNo": "sample string 4",
      "Street": "sample string 5",
      "Suburb": "sample string 6",
      "PostCode": "sample string 7",
      "Listed": true,
      "PropertyManager": "sample string 9",
      "ListingAgent": "sample string 10",
      "DateBorrowedUTC": "2025-10-25T14:43:43.9238701+00:00",
      "DueBackDateUTC": "2025-10-25T14:43:43.9238701+00:00",
      "DateReturnedUTC": "2025-10-25T14:43:43.9238701+00:00",
      "ProcessedBy": "sample string 14",
      "BorrowerType": "sample string 15",
      "StaffLoan": "sample string 16",
      "Company": "sample string 17",
      "Mobile": "sample string 18",
      "Email": "sample string 19",
      "BookingReason": "sample string 20"
    }
  ]
}

application/xml, text/xml

Sample:

<KeyBookData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.KeyTracker">
  <DataRecords>
    <KeyBook>
      <AgentName>sample string 1</AgentName>
      <BookingReason>sample string 20</BookingReason>
      <BorrowerType>sample string 15</BorrowerType>
      <Company>sample string 17</Company>
      <DateBorrowedUTC>2025-10-25T14:43:43.9238701+00:00</DateBorrowedUTC>
      <DateReturnedUTC>2025-10-25T14:43:43.9238701+00:00</DateReturnedUTC>
      <DueBackDateUTC>2025-10-25T14:43:43.9238701+00:00</DueBackDateUTC>
      <Email>sample string 19</Email>
      <KeyImageURL>sample string 2</KeyImageURL>
      <KeyNumber>sample string 3</KeyNumber>
      <Listed>true</Listed>
      <ListingAgent>sample string 10</ListingAgent>
      <Mobile>sample string 18</Mobile>
      <PostCode>sample string 7</PostCode>
      <ProcessedBy>sample string 14</ProcessedBy>
      <PropertyManager>sample string 9</PropertyManager>
      <StaffLoan>sample string 16</StaffLoan>
      <Street>sample string 5</Street>
      <StreetNo>sample string 4</StreetNo>
      <Suburb>sample string 6</Suburb>
    </KeyBook>
    <KeyBook>
      <AgentName>sample string 1</AgentName>
      <BookingReason>sample string 20</BookingReason>
      <BorrowerType>sample string 15</BorrowerType>
      <Company>sample string 17</Company>
      <DateBorrowedUTC>2025-10-25T14:43:43.9238701+00:00</DateBorrowedUTC>
      <DateReturnedUTC>2025-10-25T14:43:43.9238701+00:00</DateReturnedUTC>
      <DueBackDateUTC>2025-10-25T14:43:43.9238701+00:00</DueBackDateUTC>
      <Email>sample string 19</Email>
      <KeyImageURL>sample string 2</KeyImageURL>
      <KeyNumber>sample string 3</KeyNumber>
      <Listed>true</Listed>
      <ListingAgent>sample string 10</ListingAgent>
      <Mobile>sample string 18</Mobile>
      <PostCode>sample string 7</PostCode>
      <ProcessedBy>sample string 14</ProcessedBy>
      <PropertyManager>sample string 9</PropertyManager>
      <StaffLoan>sample string 16</StaffLoan>
      <Street>sample string 5</Street>
      <StreetNo>sample string 4</StreetNo>
      <Suburb>sample string 6</Suburb>
    </KeyBook>
  </DataRecords>
  <Options>
    <FromUTC>2025-10-25T14:43:43.9238701+00:00</FromUTC>
    <PageNo>3</PageNo>
    <ToUTC>2025-10-25T14:43:43.9238701+00:00</ToUTC>
    <XMLAgentID>sample string 4</XMLAgentID>
  </Options>
  <RequestedData>sample string 1</RequestedData>
</KeyBookData>

multipart/form-data

Sample:

<KeyBookData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.KeyTracker"><DataRecords><KeyBook><AgentName>sample string 1</AgentName><BookingReason>sample string 20</BookingReason><BorrowerType>sample string 15</BorrowerType><Company>sample string 17</Company><DateBorrowedUTC>2025-10-25T14:43:43.9238701+00:00</DateBorrowedUTC><DateReturnedUTC>2025-10-25T14:43:43.9238701+00:00</DateReturnedUTC><DueBackDateUTC>2025-10-25T14:43:43.9238701+00:00</DueBackDateUTC><Email>sample string 19</Email><KeyImageURL>sample string 2</KeyImageURL><KeyNumber>sample string 3</KeyNumber><Listed>true</Listed><ListingAgent>sample string 10</ListingAgent><Mobile>sample string 18</Mobile><PostCode>sample string 7</PostCode><ProcessedBy>sample string 14</ProcessedBy><PropertyManager>sample string 9</PropertyManager><StaffLoan>sample string 16</StaffLoan><Street>sample string 5</Street><StreetNo>sample string 4</StreetNo><Suburb>sample string 6</Suburb></KeyBook><KeyBook><AgentName>sample string 1</AgentName><BookingReason>sample string 20</BookingReason><BorrowerType>sample string 15</BorrowerType><Company>sample string 17</Company><DateBorrowedUTC>2025-10-25T14:43:43.9238701+00:00</DateBorrowedUTC><DateReturnedUTC>2025-10-25T14:43:43.9238701+00:00</DateReturnedUTC><DueBackDateUTC>2025-10-25T14:43:43.9238701+00:00</DueBackDateUTC><Email>sample string 19</Email><KeyImageURL>sample string 2</KeyImageURL><KeyNumber>sample string 3</KeyNumber><Listed>true</Listed><ListingAgent>sample string 10</ListingAgent><Mobile>sample string 18</Mobile><PostCode>sample string 7</PostCode><ProcessedBy>sample string 14</ProcessedBy><PropertyManager>sample string 9</PropertyManager><StaffLoan>sample string 16</StaffLoan><Street>sample string 5</Street><StreetNo>sample string 4</StreetNo><Suburb>sample string 6</Suburb></KeyBook></DataRecords><Options><FromUTC>2025-10-25T14:43:43.9238701+00:00</FromUTC><PageNo>3</PageNo><ToUTC>2025-10-25T14:43:43.9238701+00:00</ToUTC><XMLAgentID>sample string 4</XMLAgentID></Options><RequestedData>sample string 1</RequestedData></KeyBookData>