Web Service Documentation / Categories / Property Use Services / Get What Changed Property Use List

Get What Changed Property Use List

Updated on June 7, 2021

Description

This web service returns a list of property uses that had their name or use details modified since a user specified date. The list of property uses returned are account specific. Results are returned in increments of 1,000 per set. The returned list only shows property uses that you have permission to view. Actions that trigger a property use to be included in the returned list may have been performed by any user with property use access. Changes that result in a property use being returned are as follows:
     - a use detail within the property use is corrected or updated with a new historical record
     - the name of the property use is edited

Version

18.0

HTTP Method

GET

Resource URL

/customer/(customerId)/propertyUse/whatChanged?date=(YYYY-MM-DD)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

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.

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves the second page of a list of property uses that changed since 2010-07-31. These property uses are for the customer that has an id of 100.

GET  /customer/100/propertyUse/whatChanged?nextPageKey=3000&date=2010-07-31

Example Responses

The following example returns a list of property uses 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 use.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="861" httpMethod="GET" link="/propertyUse/861" linkDescription="This is the GET url for this property use." hint="office"/>
          <link id="341" httpMethod="GET" link="/propertyUse/341" linkDescription="This is the GET url for this property use." hint="Warehouse"/>
          <link httpMethod="GET" link="/customer/100/propertyUse/whatChanged?nextPageKey=4000&date=2010-07-31" linkDescription="next page"/>
          <link httpMethod="GET" link="/customer/100/propertyUse/whatChanged?previousPageKey=3000&date=2010-07-31" linkDescription="previous page"/>
     </links>
</response>

A list with no property uses is returned. No property uses have changed.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links/>
</response>
LIVE