Skip to content

Events High Event List API

SoumyaSian edited this page Nov 17, 2017 · 7 revisions

1.1 Fetch Events List

Intent

fetching_events

Request Params Description

KEYWORD DESCRIPTION
CITY city name to get list of events

Payload

{
  	"city" : "$CITY"
}

Response Params Description

KEY DESCRIPTION
EVENT_ID EventsHigh ID for an event
CITY Event City
TITLE Event Title
BANNER_IMAGE Primary Event Image URL
EVENT_URL URL gives complete details about the event
UPCOMING_OCCURENCE List of all upcoming occurrences for the event
UPCOMING_OCCURENCE.START_DATE Start date of an upcoming occurrence of the event with time
UPCOMING_OCCURENCE.END_DATE End date an upcoming occurrence of the event with time
UPCOMING_OCCURENCE.TIME_ZONE Name of the time zone
VENUE_NAME Venue name of the event
VENUE_ADDRESS Venue address of the event
LATITUDE Latitude of the location
LONGITUDE Longitude of the location
PRICE A JSON Array of different pricing tiers for an event
PRICE.TICKET_ID EventsHigh ID of an event
PRICE.TICKET_TYPE Name of the price tier
PRICE.TICKET_PRICE The ticket price value
PRICE.DISCOUNTED_PRICE If discount_pct>0, this represents the new ticket price value.

Response Body

 {
        "event_id": "$EVENT_ID",
        "city" : "$CITY"
        "title": "$TITLE",
        "bannerImage": "$BANNER_IMAGE",
        "eventUrl": "$EVENT_URL",
        "upcoming_occurrences": [
            {
                "startDate": "$START_DATE",
                "endDate": "$END_DATE",
                "timezone": "$TIME_ZONE"
            }
        ],
        "venueName": "$VENUU_NAME",
        "venueAddress": "$VENUE_ADDRESS",
        "latitude": $LATITUDE,
        "longitude": $LONGITUDE,
        "prices": [
            {
                "ticket_id": $TICKET_ID,
                "ticket_type": "$TICKET_TYPE",
                "ticket_price": $TICKET_PRICE,
                "discounted_price": $DISCOUNTED_PRICE
            }...,
        ]
    }....
]

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
400 Please specify the city city is missing.
Clone this wiki locally