Search (/products)

The search call allows you to search the ATDW data and return high level information for products. There are a variety of parameters you can use to filter your results and to control the output. This page gives details and examples of each of these parameters. You can combine the different filters to return highly relevant results.

ATLAS2 API Online User Guide

Please enter your distributor key here to update the links on the page.

Quick Start

All apartments within the term 'views' with results returned in JSON format

http://[host]/api/atlas/products?key=[key]&cla=APARTMENT&term=views

Full Text Search (&term)

The 'term' parameter allows for a full text search of ATDW data. The API will return all products which return the product in the name, description, classification, attribute, region, area or suburb/city. The search uses common techniques such as ignoring common words and dropping common word endings. Results will be ordered by relevancy unless the order parameter is used.

OPTIONS :
Any text value. Enclosing terms in quotes will result in phrase searching.
DEFAULT :
-
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&term=whale watching
Find all products containing the term 'whale watching'.

Category Filter (&cats)

The 'cats' parameter allows you to filter the results by categories such as Accommodation, Attractions or Events. You can select multiple categories using a comma separated list. The response will contain products in any of the specified categories.

OPTIONS :
A valid category e.g. (ACCOMM, ATTRACTION, DESTINFO, HIRE, EVENT, TRANSPORT, RESTAURANT, INFO, TOUR). Please refer to the content structure to obtain details of all categories or use the categories call.
DEFAULT :
Any
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&cats=ACCOMM,ATTRACTION
Find all products within the ACCOMM and ATTRACTION categories.

Classification Filter (&cla)

Each ATDW category has a set of classifications to identify different types of products within that category. The 'cla' parameter allows you to filter the results by classification such as hotels, farm stays or resorts. You can select multiple classifications using a comma separated list. The response will contain products with at least one of the requested classifications.

OPTIONS :
A valid classification e.g. (HOTEL, RESORT). Please refer to the content structure to obtain details of all classifications or use the classifications call.
DEFAULT :
Any
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&cla=HOTEL,RESORT
Find all products within the HOTEL and RESORT classifications.

Attribute Filter (&att)

Each ATDW product has a set of associated attributes to tell you more about the facilities or activities you can enjoy at the location. The 'att' parameter allows you to filter the results by attribute. You can select multiple attributes using a comma separated list (to apply an AND condition in search) or a pipe seperated list (to apply an OR condition in search). This allows you to find very specific sets of products.

OPTIONS :
Attribute codes are a combination of the attribute type and attribute with the spaces removed e.g. ENTITYFAC BBQ becomes ENTITYFACBBQ. Please refer to the content structure to obtain details of all attributes or use the Attributes call. all attributes or use the Tags call.
DEFAULT :
Any
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&att=ENTITYFACBBQ,ACTIVITYCAMP
Find all products with the BBQ and CAMP attributes.

External Product Search

TXA enabled products are stored in the ATDW Database with the codes of TXA_DEFAULT and TXA_MULTI.
Products denoted with TXA_DEFAULT means that there is a single point, where products with TXA_MULTI. have multiple booking points.
To retrieve a list of products which are TXA enabled, the following filter can be applied - &att=ESC_TXA_DEFAULT|ESC_TXA_MULTI.
The GetProduct call (under the EXTERNAL system) will return the V3 short names for each product too.

To retrieve products with specific social media links, the same filtering can be applied by appending the social media name reference at the end - &att=ESC_FACEBOOK.
Please see the list below for the social media links references.

VALID CODES :
  • ESC_TXA_DEFAULT
  • ESC_TXA_MULTI
  • ESC_HOTELSCOMBINED
  • ESC_BOOKEASY
  • ESC_EXPEDIAID
  • ESC_TRIPADVISORID
  • ESC_TRUSTYOUID
  • ESC_FACEBOOK
  • ESC_TWITTER
  • ESC_YOUTUBE
  • ESC_PINTEREST
  • ESC_FLICKR
  • ESC_INSTAGRAM
  • ESC_GOOGLEPLUS
  • ESC_TRIPADVISO
  • ESC_APPLEAPP
  • ESC_ANDROIDAPP
  • ESC_FOURSQUARE
  • ESC_OTHERURL
  • ESC_BLOGPAGE

Geospatial Search (&latlong and &dist)

The 'latlong and dist' parameters allow you to search for products within a number of kilometres from a specified location. If you perform a geospatial search you will also be given a 'nearest location' in the results. If a product has multiple locations then this value is the closest location to your search position.

Note that geospatial searches check product locations for all categories, and for Tour and Transport products will also check service locations.

OPTIONS :
A valid latitude an longitude combination separated by a comma. The 'dist' parameter takes an integer value.
DEFAULT :
If a location is provided the default search radius is 100km.
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&latlong=-27,153&dist=50
Find all products within 50km of -27,153.

Polygon Search (&ply)

The 'ply' parameter allows you to find all products within a defined polygon.

Note that polygon searches check product locations for all categories, and for Tour and Transport products will also check service locations.

OPTIONS :
A polygon defined in WKT format. The polygon must be closed so the start location should equal the end location.
DEFAULT :
-

State Filter (&st)

All ATDW products and service are associated with different States. You can query by State using the 'st' parameter to search within product-level location and/or 'servicest' to search within service-level location.

OPTIONS :
A valid state code e.g. NSW,QLD,NT,WA,SA,VIC,TAS,ACT.
List of states can be retrieved using the States API call.
DEFAULT :
All states
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&st=NSW
Find all products where product-level State = New South Wales

http://[host]/api/atlas/products?key=[key]&servicest=QLD
Find all products where service-level State = Queensland

http://[host]/api/atlas/products?key=[key]&st=QLD&servicest=NT
Find all products where product-level State = Queensland and service-level State = Northern Territory
Search lookup will be performed within a single listing having product and service location

Suburb/City Filter (&ct)

All ATDW products and service are associated with different suburb/cities. You can query by suburb/city using the 'ct' parameter to search within product-level location and/or 'servicect' to search within service-level location.

OPTIONS :
A valid suburb/city name or id
List of Suburb/City can be retrieved using the Suburbs API call.
DEFAULT :
All suburb/cities
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&ct=Brisbane City
Find all products where product-level City = 'Brisbane City'.

http://[host]/api/atlas/products?key=[key]&servicect=69000515
Find all products where service-level City = 69000515 (Brisbane City).

http://[host]/api/atlas/products?key=[key]&ct=Longreach&servicect=Innamincka
Find all products where product-level City = Longreach, QLD and service-level City = Innamincka, SA.
Search lookup will be performed within a single listing having product and service location

Area Filter (&ar)

All ATDW products are associated with different areas. You can query by area using the 'ar' parameter to search within product-level location and/or 'servicear' to search within service-level location.

OPTIONS :
A valid area name or area id or area code.
List of areas can be retrieved using the Areas API call.
DEFAULT :
All areas
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&ar=Darwin Area
Find all products where product-level Area = 'Darwin Area'.

http://[host]/api/atlas/products?key=[key]&servicear=DWN
Find all products where service-level Area = DWN (Darwin Area).

http://[host]/api/atlas/products?key=[key]&servicear=39000006
Find all products where service-level Area = 39000006 (Darwin Area).

http://[host]/api/atlas/products?key=[key]&ar=Longreach Area&servicear=Flinders Ranges
Find all products where product-level area = 'Longreach Area' (QLD) and service-level Area = 'Flinders Ranges' (SA).
Search lookup will be performed within a single listing having product and service location

Region Filter (&rg)

All ATDW products are associated with different regions. You can query by region using the 'rg' parameter to search within product-level location and/or 'servicerg' to search within service-level location.

OPTIONS :
A valid region name or region id or region code.
A list of regions can be retrieved from the web service using the regions call.
DEFAULT :
All regions
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&rg=Experience Perth
Find all products where product-level Region = 'Experience Perth'.

http://[host]/api/atlas/products?key=[key]&servicerg=79000178
Find all products where service-level Region = 'Experience Perth'.

http://[host]/api/atlas/products?key=[key]&rg=Outback Queensland Region&servicerg=Flinders Ranges and Outback
Find all products where product-level region = 'Outback Queensland Region' (QLD) and service-level region = 'Flinders Ranges and Outback' (SA).
Search lookup will be performed within a single listing having product and service location

Date Filter (&start, &end)

Events have start and end dates. You can query a time period to find products that fall inside that range.

OPTIONS :
A pair of dates in [YYYY-MM-DD] format
DEFAULT :
-
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&cats=event&start=2018-01-01&end=2018-12-31
Find all Events that occur between 1 Jan 2018 and 31 Dec 2018

Indicative Rate From (&minRate)

All ATDW products with an indicative rate greater than the specified 'minRate' parameter.

OPTIONS :
A decimal value representing an indicative rate
DEFAULT :
All rates
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&minRate=300
Find all products with an indicative rate starting from $300.

Indicative Rate To (&maxRate)

All ATDW products with an indicative rate less than specified maxRate parameter.

OPTIONS :
A decimal value representing an indicative rate
DEFAULT :
All rates
EXAMPLE :
http://[host]/api/atlas/products?key=[key]&maxRate=300
Find all listings with an indicative rate up to $300.

Star Rating Filter (&starrating)

All Accommodation listings that match the specified Star Rating parameter.

OPTIONS :
  • A comma seperated list of numbers representing star ratings

  • Note:
  • Star rating is applicable to Accommodation category only
  • Minimum star rating is 1 and maximum star rating is 5
  • -1 represents listings without star ratings
  • VALID VALUES :
    -1, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5
    DEFAULT :
    All listings with/without star ratings
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&starrating=5
    Find all listings that are 5 star rated

    http://[host]/api/atlas/products?key=[key]&starrating=1,1.5,2,2.5,3
    Find all listings rated between 1 to 3 stars

    http://[host]/api/atlas/products?key=[key]&starrating=-1
    Find all listings that does not have any star ratings

    Tags Filter (&TAGS)

    All ATDW products optionally has set of associated tags. The 'TAGS' parameter allows you to filter the results by tags.
    Tags are unique to distributor keys.
    To view a list of available tags for your distributor key please see Tags call.

    OPTIONS :
  • Comma (,) separated tags imply AND condition in search
  • Pipe (|) seperated tags imply OR condition in search.
  • DEFAULT :
    -
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&TAGS=Adventure,Family,Sports
    Find all products having all 3 tags: Adventure, Family and Sports tag.

    http://[host]/api/atlas/products?key=[key]&TAGS=Adventure|Family|Sports
    Find all products having any one of the 3 tags: Adventure, Family or Sports tag.

    Reduced Response (&dsc)

    This parameter allows you to request a reduced output with no description. This can be used as a performance improvement where the description is not used from the initial search.

    OPTIONS :
    true or false
    DEFAULT :
    true
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&dsc=false
    Find all products but do not return the description field in the search results.

    Facted Search (&facets)

    The 'facets' parameter allows you to request information to support faceted searching. Along with the search results you will receive a breakdown to show the number of results with a specific criteria. You can currently supply 3 values. These are 'cats', 'cla' and 'att' to facet on category, classification and attribute respectively.

    OPTIONS :
    categories (cats), classifications (cla) or attributes (att)
    DEFAULT :
    none
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&facets=cats
    Find all products but and return a breakdown of the number of results in each category.

    Bulk Upload (&uploadedThroughBulk)

    The 'uploadedThroughBulk' parameter allows you to view the breakdown of results to show whether products were added manually or via bulk upload tool (Contribution API / Import CSV).

    OPTIONS :
    true or false
    DEFAULT :
    none
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&uploadedThroughBulk=true
    Find all products uploaded via bulk upload tool (Contribution API / Import CSV) only.

    http://[host]/api/atlas/products?key=[key]&uploadedThroughBulk=false
    Find all products created using web app (www.atdw-online.com.au) only.

    Note: If the bulk upload parameter is not specified, API will return all listings i.e., results from combination of true & false will be returned
    http://[host]/api/atlas/products?key=[key]
    Find all products irrespective of whether the products were uploaded via bulk upload tool or created via web app.

    Paging (&pge and &size)

    There are a couple of parameters to control paging. These are 'pge' for page number and 'size' for results per page. To enable you to calculate the number of pages the 'number of results' is returned from the search call.

    OPTIONS :
    Any page number / page size valid for the number of results returned.
    DEFAULT :
    none
    EXAMPLE :

    Output (&out)

    Results can be requested in JSON or XML format.

    OPTIONS :
    xml or json
    DEFAULT :
    xml
    EXAMPLE :

    Market Variant (&mv)

    To obtain results in a different market variant you can use the 'mv' parameter.

    OPTIONS :
    Language
    Language Code
    Chinese Simplified
    CHINESE-S
    Chinese Traditional
    CHINESE-T
    German
    GERMAN
    French
    FRENCH
    Japanese
    JAPANESE
    Italian
    ITALIAN
    Korean
    KOREAN
    Portuguese
    PORT-EUR
    Spanish
    SPAN-EUR
    DEFAULT :
    ENGLISH
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&mv=CHINESE-T
    Find all products in Traditional Chinese.

    Field List (&fl)

    You can use the 'fl' parameter to return a subset of the data from the default return results.

    OPTIONS :
    owning_organisation_id - Retrieves the 24 character alphanumeric string generated by database
    owning_organisation_number - Retrieves the 5-10 character alphanumeric string generated by database
    owning_organisation_name - Retrieves the name of the organisation
    product_id - Retrieves the 24 character alphanumeric string generated by database
    product_number - Retrieves the 9 character alphanumeric string that starts with 'AU'
    product_name - Retrieves the name of the product
    product_description - Retrieves the description of the product
    product_image - Retrieves the URL for the product image
    product_classifications - Retrieves the list of product classifications that are associated to the product
    product_category - Retrieves the product category the product is associated to eg. Event
    address - Retrieves the address of the product
    boundary - Retrieves the geo code location for the product
    start_date - For products in category Event, and Tours, the start date will indicate when it will begin
    end_date - For products in category Event, the end date indicates the last day of the event
    starrating - The star rating value for product. This field is specifically for Accommodation category products
    rate_from - Is the minimum price of product.
    rate_to - Is the maximum price of product.
    trip_advisor - Retrieves whether or not the product has a trip advisor review associated to it, as a 'true' or 'false' value.
    txa_identifier - A list of strings used to identify a product to V3's booking services. This field can be null if no such identifiers exist.
    internet_points - Retrieves details of internet access points (paid or free) close to the product. This field can have multiple values.
    comms - Retrieves details of phone, email, url and booking url for the product.
    comms_ph - Retrieves the phone number for the product if it exists. This field can have primary and secondary phone numbers.
    comms_em - Retrieves the email address for the product if it exists.
    comms_url - Retrieves the website url for the product if it exists.
    comms_burl - Retrieves the booking url for the product if it exists.
    journey_distance - Retrieves the total length of a journey. This field is specifically for Journey category products
    journey_unit - Retrieves the units (kms or mtr) for the length of the journey. Use with journey_distance.
    status - Returns the status of the listing. Can be one of 3 states - ACTIVE, INACTIVE, EXPIRED. Please see delta for usage.
    next_occurrence - Retrieves the date of next occurrence of the event.
    DEFAULT :
    By default we return product_id, product_number, status, owning_organisation_id, owning_organisation_number, owning_organisation_name, product_name, product_description, product_category_id, product_image, boundary, addresses, next_occurrence, score, product_pixel_url

    Order (&order)

    You can use the order parameter to sort the results

    OPTIONS :
    The following sorting options are available along with the capability to post fix with "asc" to sort by ascending or "desc" to sort by descending order.
  • If post fix ('asc', 'desc') is not specified, the default ordering is ascending.
  • Post fix ('asc', 'desc') is not valid for random sorting (rnd) and seeded random search (rand_{seedvalue})

  • Parameter value
    Description
    dist
    sort by only the distance away from the specified latlong

    lang
    sort results by language. Results will be sorted by translations at the top followed by non-translated products. Should be used with &mv parameter, otherwise has no effect.

    rnd
    Sort results in random order on a single/current page only

    rand_{seedvalue}

    'Random Seeded Search'. By specifying a seed value, you can ensure randomly ordered set of results are unique during pagination i.e., same set of results across different pages for the given session.

    Implementation guide:

  • An initial request to the server with the seed value contains “Set-Cookies” field in the response header with the cookie name: “b1pi” and a cookie value (eg: “vvM4QVn1FsuIOlIEwyRke/zj8vgyFT9ozES1XpqUWlc”)
  • Pass the same cookie in the subsequent requests via request header with different page numbers to obtain unique results sorted randomly
  • Additional information:
    • HTTP clients like ‘Guzzle’ has built-in cookie management that automatically tracks the cookies across sessions


    Note:
    You can sort results by any of the fields highlighted in the Field List (&fl) parameter as long as the request contains those Field List parameters.
    DEFAULT :
    By default, the results are sorted randomly (rnd) for the given page only.
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&cats=Attraction&latlong=-33.855035,151.216205&dist=10&order=dist desc
  • Return all Attraction listings within 10 KM radius of the given latlong (Sydney Opera House) sorting the result by descending order of the distance.
  • By default, the results will be sorted by ascending order of distance so, specifying the post fix 'asc' is optional

  • http://[host]/api/atlas/products?key=[key]&mv=CHINESE-T&order=rnd,lang
    Return all listings, first those with Chinese translations and then those without. Within those categories, order the products randomly.

    http://[host]/api/atlas/products?key=[key]&order=rnd
  • Return all listings sorting the results randomly for the given page only.
  • Random ordering with pagination (eg: &pge=2&order=rnd) might show duplicate products/listings from previous page as random order (rnd) is applicable for the given page only.

  • http://[host]/api/atlas/products?key=[key]&order=rand_2018-05-15
  • Return all listings sorting the results randomly ensuring the results are unique across all pages for the given session.
  • Note:
    • '2018-05-15' in the above example is the seed value which can be replaced with any value and must be constant during Pagination for the given seed value and session.
    • Clearing cookies and re-trying will return different set of results but those results will be unique and in random order across all pages for the given seed value and session.

    http://[host]/api/atlas/products?key=[key]&fl=starrating&order=starrating desc
  • Return all listings sorting the results by descending order of starrating.
  • By default, the results will be sorted by ascending order of starrating so, specifying the post fix 'asc' is optional

  • http://[host]/api/atlas/products?key=[key]&fl=next_occurrence&order=next_occurrence desc
    Return all listings sorting the results by descending order of the date value displayed within 'next_occurrence' field.

    Additional Query Filter (&additionalQuery)

    Additional query filter allows users to filter search results by using any fields associated with the listings/products.

    OPTIONS :
  • Valid field-value pair
  • Query parameter and field-value pair are case-sensitive
  • DEFAULT :
    -
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&additionalQuery=owningOrganisationName:("DEWNR")
    Find all products owned by the organisation name: "DEWNR".

    http://[host]/api/atlas/products?key=[key]&additionalQuery=owningOrganisationNumber:("SAAS86")
    Find all products owned by the organisation number: "SAAS86" (Organisation Name: DEWNR).

    http://[host]/api/atlas/products?key=[key]&additionalQuery=owningOrganisationId:("56b1f48a44feca3df2e4ae5c")
    Find all products owned by the organisation ID: "56b1f48a44feca3df2e4ae5c" (Organisation Name: DEWNR).

    http://[host]/api/atlas/products?key=[key]&additionalQuery=productCategory:Attraction AND owningOrganisationName:("DEWNR","Tourism Barossa","City of Adelaide")
    Find all ATTRACTION products owned by the organisations: "DEWNR","Tourism Barossa","City of Adelaide".

    http://[host]/api/atlas/products?key=[key]&additionalQuery=productNumber:("AU0147955","AU0022815","AU0024549")
    Find all products by their respective product numbers.

    http://[host]/api/atlas/products?key=[key]&additionalQuery=productId:("56b249b9b042386245d51fa9","5a1cd3e820a80937204e6656","56b2481ed270154b45549dcf")
    Find all products by their respective product ID's.

    http://[host]/api/atlas/products?key=[key]&additionalQuery=-productId:("56b263fd2880253d74c4c8ff","58c0cd0d179149fb2665af70")
  • Filter search results by excluding product(s) using their ID's.
  • Note:This functionality can be used with any input parameters which precede with '-' indicating negate