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 host and 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 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'.

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 :
-

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.

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.

    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_BOOKEASY
    • ESC_TRIPADVISORID
    • ESC_TRUSTYOUID
    • ESC_FACEBOOK
    • ESC_TWITTER
    • ESC_YOUTUBE
    • ESC_PINTEREST
    • ESC_FLICKR
    • ESC_INSTRAGRAM
    • ESC_GOOGLEPLUS
    • ESC_TRIPADVISO
    • ESC_APPLEAPP
    • ESC_ANDROIDAPP
    • ESC_FOURSQAURE
    • ESC_OTHERURL
    • ESC_BLOGPAGE

    State Filter (&st)

    All ATDW products are associated with different states. You can query by state using the 'st' parameter.

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

    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=2017-01-01&end=2017-12-31
    Find all Events that occur between 1 Jan 2017 and 31 Dec 2017

    Region Filter (&rg)

    All ATDW products are associated with different regions. You can query by region using the 'rg' parameter.

    OPTIONS :
    A valid region code or id. 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 within the 'Experience Perth' region.

    Area Filter (&ar)

    All ATDW products are associated with different areas. You can query by area using the 'ar' parameter.

    OPTIONS :
    A valid area name or id. A list of areas can be retrieved using the areas call.
    DEFAULT :
    All areas
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&ar=Darwin Area
    Find all products within 'Darwin Area'.

    City Filter (&ct)

    All ATDW products are associated with different cities. You can query by city using the 'ct' parameter.

    OPTIONS :
    A valid city name or id
    DEFAULT :
    All cities
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&ct=Brisbane City
    Find all products within 'Brisbane City'.

    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 products with an indicative rate up to $300.

    AAA Star Rating Filter (&ratings)

    All ATDW products that match the specified AAA Star Ratings parameter.

    OPTIONS :
    A comma seperated list representing AAA Star Ratings - -1 returns only unrated products
    VALID VALUES :
    -1, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5
    DEFAULT :
    All ratings
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&ratings=-1,3.5,4,4.5,5
    Find all unrated products and all products with a rating of 3.5 or higher

    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 :
    CHINESE-T or CHINESE-S
    DEFAULT :
    ENGLISH
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]]&mv=CHINESE-T
    Find all products in Traditional Chinese.

    Order (&order)

    If the 'term' parameter is used sorting will be by relevance. Otherwise results can be sorted by distance (dist) if a latlong is provided or randomly (rnd).

    OPTIONS :
    The following ordering options are available, along with the capability to post fix with "asc" or "desc" to order by ascending or descending order. If this is not specified, the default ordering is ascending. (This post fix is not valid for rnd and rand_* values.)

    dist - order by only the distance away from the specified latlong.
    lang - sort results by other specified parameters, then bump any non-translated products to the end of the result list. Should be used with &mv parameter, otherwise has no effect.
    rnd - order randombly
    rand_{seedvalue} - by specifying a seed value you can ensure a randmoly ordered set of results are unique during paging. eg.&order=rand_abc&pge=2
    Additionally, you can order by any of the fields highlighted in the fl parameter values eg. &order=rating_aaa will order by AAA star rating.
    DEFAULT :
    By default we order by relevancy to the 'term' and /or 'dist' parameters (if specified) and then by the product name in ascending alphabetical order.
    EXAMPLE :
    http://[host]/api/atlas/products?key=[key]&mv=CHINESE-T&order=rnd,lang
    Return all products, first those with Chinese translations and then those without. Within those categories, order the products randomly.

    Field List (&fl)

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

    OPTIONS :
    product_id - Retrieves the seven digit product id, concatenated with GUID identifying the product call session
    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
    landscape_image - Retrieves the URL for the landscape-format image for this product. This will be the same URL as product_image unless that resolves to a portrait-format image. This field can be used by distributors who have their site formatting set up to only accept landscape images.
    geo - 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
    rating_aaa - The AAA 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.
    address - Retrieves the address of the product as a single line
    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 (tollfree or paid), fax, mobile, email, url, booking url and wap for the product. Each type can have multiple values.
    comms_ph - Retrieves the phone number (tollfree or paid) for the product if it exists. This field can have multiple values.
    comms_mb - Retrieves the mobile number for the product if it exists. This field can have multiple values.
    comms_fx - Retrieves the fax number for the product if it exists. This field can have multiple values.
    comms_burl - Retrieves the booking url for the product if it exists. This field can have multiple values.
    comms_url - Retrieves the website url for the product if it exists. This field can have multiple values.
    comms_wap - Retrieves the WAP address for the product if it exists. This field can have multiple values.
    comms_em - Retrieves the email address for the product if it exists. This field can have multiple values.
    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_name, product_description, product_image, tqual, boundary, product_category_id .