Skip to content

CT Local Activities Fetch Activity Details

SoumyaSian edited this page Oct 24, 2017 · 8 revisions

1.4 Fetch Activity Details

Intent

fetch_activity_details

Request Params Description

KEYWORD DESCRIPTION
CITY_ID Cleartrip ID for a City
VARIATION_ID Cleartrip ID for a variant

Payload

{
  	"cityId":"$CITY_ID,
  	"variationId":"$VARIATION_ID"
}

Response Params Description

KEY DESCRIPTION
IS_GST_APPLICABLE True or false (true represent GST applicable and false represent GST not applicable)
IMAGES URL path of image for this activity or variant
IMAGES.IMAGE URL path for this activity or variant
ACTIVITY_ID Cleartrip ID for an activity
ACTIVITY_NAME Name of activity
INCLUSIONS List of inclusions
ADDRESS Activity Address Information Object
ADDRESS.COUNTRY Country Name of an activity
ADDRESS.ADDRESS_TYPE Address type (activity address or pickup address of this activity)
ADDRESS.ADDRESS2 Secondary Address if activity exists in more than one place
ADDRESS.CITY City of an activity
ADDRESS.ADDRESS1 Primary address of an activity
ADDRESS.LATITUDE Latitude of the location of an activity
ADDRESS.STATE State pertaining to the activity
ADDRESS.LONGITUDE Longitude of the location of an activity
ADDRESS.LOCALITY_NAME locality name of an activity
CHILD_AGE_RESTRICTION Minimum age of a child to participate in the activity
DESCRIPTION Full description of this activity or variant
SINGLE_LINE_DESCRIPTION One line description of this activity or variant
RATINGS.BAD Array of bad ratings
RATINGS.GOOD Array of good ratings
RATINGS.AVG_RATING Average rating of overall ratings
RATINGS.RATINGS_COUNT Total number of ratings
RATINGS.REVIEW_COUNT Total count of reviews
RATINGS.REVIEW Array of reviews
PUBLISHED_TIME Date and time of an activity published
MEETING_POINT Meeting points of the activity if available else null
PICKUP_POINTS Pickup points of the activity if available else null
OPEN_ACTIVITY True or false (true represent unschedule activity and false represent schedule activity)
DRESS_CODE Dress code for an activity
RATES List of all rates available for this activity or variant
RATES.CHEAPEST_RATES This is cheapest price we will use to show on ui for adult(adt) , child(chd) and group(un
RATES.IS_UNIT_TYPE True or false, true represent this activity is a group activity
RATES.RATE_ID Id of rates
RATES.CANCELLATION List of cancellation policy available
RATES.CANCELLATION.CHARGE_TYPE 1 or 2, 1 represents flat cancellation charge in a given currency and 2 represent flat cancellation in percentage.
RATES.CANCELLATION.LEAD_HOUR Refund Time slots (From 0 to given hour value)
RATES.CANCELLATION.VALUE Cancellation value depends on charge_type currency or percentage
RATES.PRICES List of pricing available for an activity (weekday and weekends price)
RATES.WHEN List of time and duration
RATES.WHEN.DURATION Duration of the activity
RATES.WHEN.IS_AVALIABLE_TODAY True or false (true represents activity is available for the current date and false represent activity is not available)
RATES.WHEN.EXPAND True or false (true represents activity timings are flexible and false represents activity timings are not flexible
RATES.WHEN.TIMINGS Timings of an activity
RATES.INCLUSIONS Inclusions for an activity
RATES.RATE_NAME Name of the rates
RATES.ORDER Order of the rates
RATES.ABOUT About the rates
HIGHLGHTS List of highlights for an activity
MIN_PRICE Minimun price of an activity
VARIATION_ID Cleartrip ID for a variation(null if no variation exists)
GROUP_ACTIVITY True or false (true represents activity is a group activity and false represents activity is not a group activity)

Response Body

{
	"isGstApplicable": $IS_GST_APPLICABLE,
	"images": [{
      		"order_no": "$ORDER_NO",
      		"image": "$IMAGE"
   	}..],
	"activityId": $ACTIVITY_ID,
  	"activityName": "$ACTIVITY_NAME",
	"inclusions": [
        		"$INCLUSIONS",
                      ...
		      ],
        "address": {
        	   "country": "$COUNTRY",
       		   "address_type": "$ADDRESS_TYPE",
        	   "address2": "$ADDRESS2,
        	   "city": "$CITY",
        	   "address1": "$ADDRESS1",
        	   "pin_code": "$PINCODE",
                   "latitude": "$LATITUDE",
                   "state": "$STATE",
                   "longitude": "$LONGITUDE",
        	   "city_id": $CITY_ID,
                   "locality_name": "$LOCALITY_NAME"
    },
    "childAgeRestriction": "$CHILD_AGE_RESTRICTION",
    "description": "$DESCRIPTION"
    "singleLineDescription": "$SINGLE_LINE_DESCRIPTION",
    "ratings": {
        "bad": [],
        "review": $REVIEW,
        "avg_rating": $AVG_RATING,
        "ratings_count": $RATINGS_COUNT,
        "good": [],
        "reviews_count": $REVIEW_COUNT
    },
     "publishedTime": "$PUBLISHED_TIME",
    "meetingPoint": $MEETING_POINT,
    "pickUpPoints": $PICKUP_POINTS,
    "open_activity": $OPEN_ACTIVITY,
    "dressCode": [
    	${DRESS_CODE}
        ...,
    ],
    "rates": [
        {
            "cheapest_rates": {
                "adt": $ADT,
                "unit": $UNIT,
                "chd": $CHD
            },
            "is_unit_type": $IS_UNIT_TYPE,
            "cancellation": [
                {
                    "charge_type": "$CHARGE_TYPE",
                    "rate_id": $RATE_ID,
                    "lead_hour": $LEAD_HOUR,
                    "value": $VALUE
                }
              ...,
            ],
            "rate_id": $RATE_ID,
            "about": [$ABOUT],
            "prices": [$PRICES],
            "when": {
                "duration": "$DURATION",
                "isAvailableToday": $IS_AVALIABLE_TODAY,
                "expand": $EXPAND,
                "timings": "$TIMINGS"
            },
            "inclusions": [$INCLUSIONS],
            "rate_name": "{$RATE_NAME}",
            "order": $ORDER
        }
    ],
    "highlights": [$HIGHLIGHTS
        ...,
    ],
    "minPrice": $MIN_PRICE,
    "variationId": $VARIATION_ID,
    "groupActivity": $GROUP_ACTIVITY    
}

Error messages

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

Status Error message Description
300 Please specify the city city-id is missing.
400 Please specify the variant id variant-id is a required field.
Clone this wiki locally