Web Service Documentation / Categories / Property Services / Get What Changed Property List
Updated on February 26, 2024
23.0
GET
/customer/(customerId)/property/whatChanged?date=(YYYY-MM-DD)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
customerId | Id to the customer |
date | Indicates the starting date of the desired range of time. Must be a valid date formatted as YYYY-MM-DD. The ending date of the desired range of time is set to the current date. The ending date cannot be changed. |
nextPageKey | Optional. Used as a reference key to determine what results to include in the next page. This is not a page number. This is typically omitted on the initial call and is provided if the results are paginated. |
previousPageKey | Optional. Used as a reference key to determine what results to include in the previous page. This is not a page number. This is typically omitted on the initial call and is provided if the results are paginated. |
Request/Response | Schema Name |
---|---|
Request | None |
Response | response.xsd |
The following example retrieves the second result set of a list of properties that changed since 2010-07-31. These properties are for the customer that has an id of 100.
GET /customer/100/property/whatChanged?nextPageKey=3000&date=2010-07-31
The following example returns a list of properties in customerId 100 that have changed since July 31, 2010. The list contains web service links for you to call and retrieve information for each property.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
<links>
<link id="86" httpMethod="GET" link="/property/86" linkDescription="This is the GET url for this Property." hint="ACME Convenience Store"/>
<link id="34" httpMethod="GET" link="/property/34" linkDescription="This is the GET url for this Property." hint="ACME Grocery"/>
...
<link httpMethod="GET" link="/customer/100/property/whatChanged?nextPageKey=4000&date=2010-07-31" linkDescription="next page"/>
<link httpMethod="GET" link="/customer/100/property/whatChanged?previousPageKey=3000&date=2010-07-31" linkDescription="previous page"/>
</links>
</response>
A list with no properties is returned. No properties have changed.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
<links/>
</response>