-
Notifications
You must be signed in to change notification settings - Fork 0
CT Local Activities Fetch Activity Details
SoumyaSian edited this page Apr 2, 2018
·
8 revisions
fetch_activity_details
KEYWORD | DESCRIPTION |
---|---|
CITY_ID | Cleartrip ID for a City |
VARIATION_ID | Cleartrip ID for a variant |
{
"city_id":"$CITY_ID,
"variation_id":"$VARIATION_ID"
}
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 |
supplier_details | JSON Object with supplier details |
supplier_details.IMAGE | Image of the supplier |
supplier_details.NAME | Name of the supplier |
supplier_details.RATING | Rating of the supplier |
supplier_details.DESCRIPTION | Description of the supplier |
supplier_details.ID | Id of the supplier |
supplier_details.ACTIVITY_PROVIDER_NAME | Activity Provider Name |
supplier_details.IS_VERIFIED | True or False value. 'true' represents verified supplier where 'false' represents supplier is not verified |
supplier_details.EMAIL | Email of the supplier |
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 the 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 |
HIGHLIGHTS | List of highlights for an activity |
MIN_PRICE | Minimum 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) |
WEB_URL | Cleartrip website page for activity details |
{
"is_gst_applicable": $IS_GST_APPLICABLE,
"images": [{
"order_no": "$ORDER_NO",
"image": "$IMAGE"
}..],
"activity_id": $ACTIVITY_ID,
"activity_name": "$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"
},
"chld_age_hgt_res": "$CHILD_AGE_RESTRICTION",
"description": "$DESCRIPTION"
"one_line_description": "$SINGLE_LINE_DESCRIPTION",
"ratings": {
"bad": [],
"review": $REVIEW,
"avg_rating": $AVG_RATING,
"ratings_count": $RATINGS_COUNT,
"good": [],
"reviews_count": $REVIEW_COUNT
},
"published_time": "$PUBLISHED_TIME",
"supplier_details": {
"image": $IMAGE,
"phone": "$PHONE",
"name": "$NAME",
"rating": "$RATING",
"description": "$DESCRIPTION",
"id": $ID,
"activity_provider_name": "$ACTIVITY_PROVIDER_NAME",
"is_verified": $IS_VERIFIED,
"email": "$EMAIL"
},
"meeting_point": $MEETING_POINT,
"pick_up_points": $PICKUP_POINTS,
"open_activity": $OPEN_ACTIVITY,
"dress_code_recommendation": [
${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
...,
],
"min_price": $MIN_PRICE,
"variation_id": $VARIATION_ID,
"group_activity": $GROUP_ACTIVITY,
"web_url": "$WEB_URL"
}
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_id & variation_id are required fields | city_id & variation_id are missing. |
400 | variation_id is required field | variation_id is missing. |
400 | city_id is required field | city_id is missing. |