GET v1/agentdata/allPropertyStats?FromUTC={FromUTC}&ToUTC={ToUTC}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FromUTC

date

None.

ToUTC

date

None.

Body Parameters

None.

Response Information

Resource Description

AgentPropertiesData
NameDescriptionTypeAdditional information
AgentPropertyDataOptions

AgentPropertyDataOptions

None.

PropertiesData

Collection of AgentPropertyData

None.

PropertyPriceHistory

Collection of PriceHistory

None.

PropertyVacancyPeriod

Collection of VacancyPeriod

None.

ApplicationComment

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "AgentPropertyDataOptions": {
    "FromUTC": "2024-09-18T06:03:47.7383543+00:00",
    "ToUTC": "2024-09-18T06:03:47.7383543+00:00"
  },
  "PropertiesData": [
    {
      "Address": {
        "StreetNo": "sample string 1",
        "Street": "sample string 2",
        "Suburb": "sample string 3",
        "State": "sample string 4",
        "PostCode": "sample string 5",
        "Country": "sample string 6"
      },
      "AdvertisingStartDate": "2024-09-18T06:03:47.7383543+00:00",
      "EnquiryVolume": 1,
      "AdvertisedRent": 2.1,
      "ApplicationPending": true,
      "Listed": true,
      "Tenanted": true,
      "RentAchieved": 6.1,
      "PriceHistory": [
        {
          "UpdateTime": "2024-09-18T06:03:47.7539826+00:00",
          "UpdatePrice": 2
        },
        {
          "UpdateTime": "2024-09-18T06:03:47.7539826+00:00",
          "UpdatePrice": 2
        }
      ],
      "VacancyPeriod": [
        {
          "OnListDate": "2024-09-18T06:03:47.7539826+00:00",
          "OffListDate": "2024-09-18T06:03:47.7539826+00:00"
        },
        {
          "OnListDate": "2024-09-18T06:03:47.7539826+00:00",
          "OffListDate": "2024-09-18T06:03:47.7539826+00:00"
        }
      ],
      "PropertyApplicationComments": [
        {
          "ApplicationID": 1,
          "Comment": "sample string 2"
        },
        {
          "ApplicationID": 1,
          "Comment": "sample string 2"
        }
      ],
      "InspectionVolume": 7,
      "ApplicationVolume": 8
    },
    {
      "Address": {
        "StreetNo": "sample string 1",
        "Street": "sample string 2",
        "Suburb": "sample string 3",
        "State": "sample string 4",
        "PostCode": "sample string 5",
        "Country": "sample string 6"
      },
      "AdvertisingStartDate": "2024-09-18T06:03:47.7383543+00:00",
      "EnquiryVolume": 1,
      "AdvertisedRent": 2.1,
      "ApplicationPending": true,
      "Listed": true,
      "Tenanted": true,
      "RentAchieved": 6.1,
      "PriceHistory": [
        {
          "UpdateTime": "2024-09-18T06:03:47.7539826+00:00",
          "UpdatePrice": 2
        },
        {
          "UpdateTime": "2024-09-18T06:03:47.7539826+00:00",
          "UpdatePrice": 2
        }
      ],
      "VacancyPeriod": [
        {
          "OnListDate": "2024-09-18T06:03:47.7539826+00:00",
          "OffListDate": "2024-09-18T06:03:47.7539826+00:00"
        },
        {
          "OnListDate": "2024-09-18T06:03:47.7539826+00:00",
          "OffListDate": "2024-09-18T06:03:47.7539826+00:00"
        }
      ],
      "PropertyApplicationComments": [
        {
          "ApplicationID": 1,
          "Comment": "sample string 2"
        },
        {
          "ApplicationID": 1,
          "Comment": "sample string 2"
        }
      ],
      "InspectionVolume": 7,
      "ApplicationVolume": 8
    }
  ],
  "PropertyPriceHistory": [
    {
      "UpdateTime": "2024-09-18T06:03:47.7539826+00:00",
      "UpdatePrice": 2
    },
    {
      "UpdateTime": "2024-09-18T06:03:47.7539826+00:00",
      "UpdatePrice": 2
    }
  ],
  "PropertyVacancyPeriod": [
    {
      "OnListDate": "2024-09-18T06:03:47.7539826+00:00",
      "OffListDate": "2024-09-18T06:03:47.7539826+00:00"
    },
    {
      "OnListDate": "2024-09-18T06:03:47.7539826+00:00",
      "OffListDate": "2024-09-18T06:03:47.7539826+00:00"
    }
  ],
  "ApplicationComment": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<AgentPropertiesData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.AgentDataNS">
  <AgentPropertyDataOptions>
    <FromUTC>2024-09-18T06:03:47.7383543+00:00</FromUTC>
    <ToUTC>2024-09-18T06:03:47.7383543+00:00</ToUTC>
  </AgentPropertyDataOptions>
  <ApplicationComment xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ApplicationComment>
  <PropertiesData>
    <AgentPropertyData>
      <Address>
        <Country>sample string 6</Country>
        <PostCode>sample string 5</PostCode>
        <State>sample string 4</State>
        <Street>sample string 2</Street>
        <StreetNo>sample string 1</StreetNo>
        <Suburb>sample string 3</Suburb>
      </Address>
      <AdvertisedRent>2.1</AdvertisedRent>
      <AdvertisingStartDate>2024-09-18T06:03:47.7383543+00:00</AdvertisingStartDate>
      <ApplicationPending>true</ApplicationPending>
      <ApplicationVolume>8</ApplicationVolume>
      <EnquiryVolume>1</EnquiryVolume>
      <InspectionVolume>7</InspectionVolume>
      <Listed>true</Listed>
      <PriceHistory>
        <PriceHistory>
          <UpdatePrice>2</UpdatePrice>
          <UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime>
        </PriceHistory>
        <PriceHistory>
          <UpdatePrice>2</UpdatePrice>
          <UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime>
        </PriceHistory>
      </PriceHistory>
      <PropertyApplicationComments>
        <ApplicationComments>
          <ApplicationID>1</ApplicationID>
          <Comment>sample string 2</Comment>
        </ApplicationComments>
        <ApplicationComments>
          <ApplicationID>1</ApplicationID>
          <Comment>sample string 2</Comment>
        </ApplicationComments>
      </PropertyApplicationComments>
      <RentAchieved>6.1</RentAchieved>
      <Tenanted>true</Tenanted>
      <VacancyPeriod>
        <VacancyPeriod>
          <OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate>
          <OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate>
        </VacancyPeriod>
        <VacancyPeriod>
          <OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate>
          <OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate>
        </VacancyPeriod>
      </VacancyPeriod>
    </AgentPropertyData>
    <AgentPropertyData>
      <Address>
        <Country>sample string 6</Country>
        <PostCode>sample string 5</PostCode>
        <State>sample string 4</State>
        <Street>sample string 2</Street>
        <StreetNo>sample string 1</StreetNo>
        <Suburb>sample string 3</Suburb>
      </Address>
      <AdvertisedRent>2.1</AdvertisedRent>
      <AdvertisingStartDate>2024-09-18T06:03:47.7383543+00:00</AdvertisingStartDate>
      <ApplicationPending>true</ApplicationPending>
      <ApplicationVolume>8</ApplicationVolume>
      <EnquiryVolume>1</EnquiryVolume>
      <InspectionVolume>7</InspectionVolume>
      <Listed>true</Listed>
      <PriceHistory>
        <PriceHistory>
          <UpdatePrice>2</UpdatePrice>
          <UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime>
        </PriceHistory>
        <PriceHistory>
          <UpdatePrice>2</UpdatePrice>
          <UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime>
        </PriceHistory>
      </PriceHistory>
      <PropertyApplicationComments>
        <ApplicationComments>
          <ApplicationID>1</ApplicationID>
          <Comment>sample string 2</Comment>
        </ApplicationComments>
        <ApplicationComments>
          <ApplicationID>1</ApplicationID>
          <Comment>sample string 2</Comment>
        </ApplicationComments>
      </PropertyApplicationComments>
      <RentAchieved>6.1</RentAchieved>
      <Tenanted>true</Tenanted>
      <VacancyPeriod>
        <VacancyPeriod>
          <OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate>
          <OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate>
        </VacancyPeriod>
        <VacancyPeriod>
          <OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate>
          <OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate>
        </VacancyPeriod>
      </VacancyPeriod>
    </AgentPropertyData>
  </PropertiesData>
  <PropertyPriceHistory>
    <PriceHistory>
      <UpdatePrice>2</UpdatePrice>
      <UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime>
    </PriceHistory>
    <PriceHistory>
      <UpdatePrice>2</UpdatePrice>
      <UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime>
    </PriceHistory>
  </PropertyPriceHistory>
  <PropertyVacancyPeriod>
    <VacancyPeriod>
      <OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate>
      <OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate>
    </VacancyPeriod>
    <VacancyPeriod>
      <OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate>
      <OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate>
    </VacancyPeriod>
  </PropertyVacancyPeriod>
</AgentPropertiesData>

multipart/form-data

Sample:
<AgentPropertiesData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models.AgentDataNS"><AgentPropertyDataOptions><FromUTC>2024-09-18T06:03:47.7383543+00:00</FromUTC><ToUTC>2024-09-18T06:03:47.7383543+00:00</ToUTC></AgentPropertyDataOptions><ApplicationComment xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></ApplicationComment><PropertiesData><AgentPropertyData><Address><Country>sample string 6</Country><PostCode>sample string 5</PostCode><State>sample string 4</State><Street>sample string 2</Street><StreetNo>sample string 1</StreetNo><Suburb>sample string 3</Suburb></Address><AdvertisedRent>2.1</AdvertisedRent><AdvertisingStartDate>2024-09-18T06:03:47.7383543+00:00</AdvertisingStartDate><ApplicationPending>true</ApplicationPending><ApplicationVolume>8</ApplicationVolume><EnquiryVolume>1</EnquiryVolume><InspectionVolume>7</InspectionVolume><Listed>true</Listed><PriceHistory><PriceHistory><UpdatePrice>2</UpdatePrice><UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime></PriceHistory><PriceHistory><UpdatePrice>2</UpdatePrice><UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime></PriceHistory></PriceHistory><PropertyApplicationComments><ApplicationComments><ApplicationID>1</ApplicationID><Comment>sample string 2</Comment></ApplicationComments><ApplicationComments><ApplicationID>1</ApplicationID><Comment>sample string 2</Comment></ApplicationComments></PropertyApplicationComments><RentAchieved>6.1</RentAchieved><Tenanted>true</Tenanted><VacancyPeriod><VacancyPeriod><OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate><OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate></VacancyPeriod><VacancyPeriod><OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate><OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate></VacancyPeriod></VacancyPeriod></AgentPropertyData><AgentPropertyData><Address><Country>sample string 6</Country><PostCode>sample string 5</PostCode><State>sample string 4</State><Street>sample string 2</Street><StreetNo>sample string 1</StreetNo><Suburb>sample string 3</Suburb></Address><AdvertisedRent>2.1</AdvertisedRent><AdvertisingStartDate>2024-09-18T06:03:47.7383543+00:00</AdvertisingStartDate><ApplicationPending>true</ApplicationPending><ApplicationVolume>8</ApplicationVolume><EnquiryVolume>1</EnquiryVolume><InspectionVolume>7</InspectionVolume><Listed>true</Listed><PriceHistory><PriceHistory><UpdatePrice>2</UpdatePrice><UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime></PriceHistory><PriceHistory><UpdatePrice>2</UpdatePrice><UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime></PriceHistory></PriceHistory><PropertyApplicationComments><ApplicationComments><ApplicationID>1</ApplicationID><Comment>sample string 2</Comment></ApplicationComments><ApplicationComments><ApplicationID>1</ApplicationID><Comment>sample string 2</Comment></ApplicationComments></PropertyApplicationComments><RentAchieved>6.1</RentAchieved><Tenanted>true</Tenanted><VacancyPeriod><VacancyPeriod><OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate><OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate></VacancyPeriod><VacancyPeriod><OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate><OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate></VacancyPeriod></VacancyPeriod></AgentPropertyData></PropertiesData><PropertyPriceHistory><PriceHistory><UpdatePrice>2</UpdatePrice><UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime></PriceHistory><PriceHistory><UpdatePrice>2</UpdatePrice><UpdateTime>2024-09-18T06:03:47.7539826+00:00</UpdateTime></PriceHistory></PropertyPriceHistory><PropertyVacancyPeriod><VacancyPeriod><OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate><OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate></VacancyPeriod><VacancyPeriod><OffListDate>2024-09-18T06:03:47.7539826+00:00</OffListDate><OnListDate>2024-09-18T06:03:47.7539826+00:00</OnListDate></VacancyPeriod></PropertyVacancyPeriod></AgentPropertiesData>