Delta Update
The batch product searching functionality is an extension of the existing product search functionality to cater for distributors that may want to download the ATDW product data to their own local database. Distributors that use ATDW product data in this way are known as Batch distributors. This functionality was supported in ATWS and has now been implemented in ATLAS version 3.0.0.
Important
ATDW assumes that the key provided will be used in a real time manner.
If delta update (batch) functionality is being used, ATDW must be notified.
If the key is being currently used on production in real time and Delta functionality is required , ATDW will provide another key.
Please contact [email protected] if a key needs to be reissued.
Quick Start
Get all listings that have been updated since 1 January 2017
https://[host]/productsearchservice.svc/products?key=[key]&delta=2017-01-01Delta (&delta)
To obtain a list of changes that have occurred after a certain time and date you can use the 'delta' parameter.
All accomodation that has been updated in QLD since 1 January 2017
Periodic query for updates
The distributor will periodically query for updates of products they are interested in so that they can download those changes to their local database. A new “delta” parameter has been introduced that will be used in conjunction with the original product search URL to retrieve only any updated products since the last time a distributor queried ATLAS. This approach is strongly recommended as distributors will only need to retrieve a small set of product information periodically.
Assuming that the distributor last requested product information on the 1 January 2017 then the periodic query would be:
The date format is yyyy-mm-dd. Optionally, if an hourly update is required the format is yyyy-mm-dd hh:mm:ss.
The response from a delta parameter query has a new field ‘status’. This field can have one of three values
- 1. ACTIVE: Is an active ATDW product whose details have been updated since the last delta date
- 2. INACTIVE: This product has effectively been deleted from ATDW since the last delta date
- 3. EXPIRED : products that have passed the date of validity as a product in ATDW since the last delta date
The default data set that is returned can be tailored to your needs by using the fl parameter
(please refer to the API guide at search.html)
For an ACTIVE ATDW product, if the supplied product details are not sufficient to be used by
the distributor, they will further make a product call to get the full details of a product
on a product id basis.
This will not be required for the other product status and should
result in those products being removed or marked as unavailable in the distributors local database.