CT Local Eatout Fetch Collection List

2.2 Fetch Collections List

Intent

fetch_eatout_collections

Request Params Description

KEY	DESCRIPTION
CITY_NAME	Name of city

Payload

{
	"city_name":"$CITY_NAME"   
}

Response Params Description

KEY	DESCRIPTION
WEB_URL	Cleartrip website URL.
collections	Array with all available collection list for the city.
editorials	Array with all available collection list for the city for an editor choice.
collections.IMAGE	URL path of the image (Image can be obtained by prefixing "http://ui.cltpstatic.com/" or "http://apistaging.cleartrip.com/" as base URL)
collections.COUNT	Number of activities available for the collection
collections.COLLECTION_NAME	Name of the collection of activities
collections.COLLECTION_ID	Cleartrip ID for a collection
collections.CITY_ID	Cleartrip ID for a city
collections.COLLECTION_URL	Web URL for collection
editorials.IMAGE	URL path of the image (Image can be obtained by prefixing "http://ui.cltpstatic.com/" or "http://apistaging.cleartrip.com/" as base URL)
editorials.COLLECTION_NAME	Name of the collection of activities
editorials.COLLECTION_ID	Cleartrip ID for a collection
editorials.CITY_ID	Cleartrip ID for a city
editorials.COLLECTION_URL	Web URL for collection

Response Body

{
 "web_url": "$WEB_URL",
 "$collections": [
        {
             "image": "$IMAGE",
             "count": $COUNT,
             "collection_name": "$COLLECTION_NAME",
             "collection_id": $COLLECTION_ID,
             "city_id": $CITY_ID,
             "collection_url": "$COLLECTION_URL"
        },..
    ],
    "$editorials":[
        {
             "image": "$IMAGE",
             "collection_name": "$COLLECTION_NAME",
             "collection_id": $COLLECTION_ID,
             "city_id": $CITY_ID,
             "collection_url": "$COLLECTION_URL"
        }...,      
     ]
}

Error messages

Some error messages, you might get an invalid search request. The HTTP response code, in this case, will be 400.

Status	Error message	Description
400	city_name is required field	City is missing.
400	There are no collections available. Please try another city	Collections List is not available for searched city or wrong city name.