7. The event_search method¶
Returns a list of available events based on a search criteria.
7.1. Required inputs¶
7.2. Optional inputs¶
- s_keys : keywords separated by spaces. A keyword search within venue and event description.
- s_dates : a date range formatted as: StartingDate, EndDate in the format: YYYYMMDD:YYYYMMDD (both optional).
- s_coco - Country Code. Restrict events per country using ISO 3166-1 country codes
- s_city - City. Restrict events per city.
- s_geo: Geographical location. Restricts events in a circular search area. Three values are needed: latitude and longitude and radius in kilometres. Ex: 51.52961137:-0.10601562:10
- s_geo_lat, s_geo_long, s_geo_rad_km: Alternative to s_geo
- s_src: only events from a specific Backend System
- s_area: only events with an Area.
- s_ven: only events at a Venue
- event_token_list: returns from a list of Event Token ex. 1VLG,1YYO,209C,226B,22AS,25DR,2569.
- request_cost_range: returns cost ranges for each event (min and max prices, details of offers)
- request_avail_details: returns a list of ticket types and price bands that are available for this event across all performances
- request_extra_info: returns full info for the event
- request_custom_fields:
7.3. Example¶
7.3.1. Example input¶
<event_search>
<user_id>demo</user_id>
<user_passwd>demo-password</user_passwd>
<s_keys>lion</s_keys>
<request_cost_range/>
<request_media>square</request_media>
<request_media>landscape</request_media>
<request_media>triplet_one</request_media>
<request_media>triplet_two</request_media>
<request_media>triplet_three</request_media>
<request_media>triplet_four</request_media>
<request_media>triplet_five</request_media>
<request_media>marquee</request_media>
<request_media>seating_plan</request_media>
</event_search>
7.3.2. Example output¶
<event_search_result>
<subdomain_user_is_bad>no</subdomain_user_is_bad>
<crypto_block>U_--vkpf9kC9pU5Ob-grofd1tGwcNPYj3ecsj3DY16jQkO0YWnDvmTKhsA3p_xUq7RLFyDc5-Rd1f6KqfuYIqgAFsCrPcyybcxWEO4r_Dm3LIEQyqrEjq89lr2PIn93DkwglY</crypto_block>
<distances_are_valid>no</distances_are_valid>
<event>
<area_code>NYCA</area_code>
<area_desc>NYCA</area_desc>
<bigup_value>90</bigup_value>
<city_code>new_york-us</city_code>
<city_desc>New York</city_desc>
<class>
<class_code>theatre</class_code>
<class_desc>Theatre</class_desc>
<is_main_class>yes</is_main_class>
<search_key>theatre/</search_key>
<subclass>
<is_main_subclass>yes</is_main_subclass>
<search_key>theatre/kids</search_key>
<subclass_code>kids</subclass_code>
<subclass_desc>Family</subclass_desc>
</subclass>
<subclass>
<is_main_subclass>no</is_main_subclass>
<search_key>theatre/musicals</search_key>
<subclass_code>musicals</subclass_code>
<subclass_desc>Musicals</subclass_desc>
</subclass>
</class>
<cost_range>
<max_combined>229.08</max_combined>
<max_seatprice>229.08</max_seatprice>
<max_surcharge>0.0</max_surcharge>
<min_combined>84.33</min_combined>
<min_seatprice>84.33</min_seatprice>
<min_surcharge>0.0</min_surcharge>
<no_singles_cost_range>
<max_combined>229.08</max_combined>
<max_seatprice>229.08</max_seatprice>
<max_surcharge>0.0</max_surcharge>
<min_combined>84.33</min_combined>
<min_seatprice>84.33</min_seatprice>
<min_surcharge>0.0</min_surcharge>
<quantity_options>
<valid_quantity>1</valid_quantity>
<valid_quantity>2</valid_quantity>
<valid_quantity>3</valid_quantity>
<valid_quantity>4</valid_quantity>
<valid_quantity>5</valid_quantity>
<valid_quantity>6</valid_quantity>
<valid_quantity>7</valid_quantity>
<valid_quantity>8</valid_quantity>
<valid_quantity>9</valid_quantity>
<valid_quantity>10</valid_quantity>
</quantity_options>
<range_currency>
<currency_code>gbp</currency_code>
<currency_factor>100</currency_factor>
<currency_number>826</currency_number>
<currency_places>2</currency_places>
<currency_post_symbol/>
<currency_pre_symbol>£</currency_pre_symbol>
</range_currency>
</no_singles_cost_range>
<quantity_options>
<valid_quantity>1</valid_quantity>
<valid_quantity>2</valid_quantity>
<valid_quantity>3</valid_quantity>
<valid_quantity>4</valid_quantity>
<valid_quantity>5</valid_quantity>
<valid_quantity>6</valid_quantity>
<valid_quantity>7</valid_quantity>
<valid_quantity>8</valid_quantity>
<valid_quantity>9</valid_quantity>
<valid_quantity>10</valid_quantity>
</quantity_options>
<range_currency>
<currency_code>gbp</currency_code>
<currency_factor>100</currency_factor>
<currency_number>826</currency_number>
<currency_places>2</currency_places>
<currency_post_symbol/>
<currency_pre_symbol>£</currency_pre_symbol>
</range_currency>
</cost_range>
<country_code>us</country_code>
<country_desc>United States of America</country_desc>
<date_range_end>
<date_desc>Thu, 14th April 2016</date_desc>
<date_utc_offset>-14400</date_utc_offset>
<date_utc_seconds>1460674800</date_utc_seconds>
<date_yyyymmdd>20160414</date_yyyymmdd>
</date_range_end>
<date_range_start>
<date_desc>Tue, 3rd November 2015</date_desc>
<date_utc_offset>-18000</date_utc_offset>
<date_utc_seconds>1446595200</date_utc_seconds>
<date_yyyymmdd>20151103</date_yyyymmdd>
</date_range_start>
<event_code>LIONKING2</event_code>
<event_desc>The Lion King</event_desc>
<event_id>2A01</event_id>
<event_lingo>theatre</event_lingo>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/220x115.jpg</insecure_complete_url>
<name>landscape</name>
<path>/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/220x115.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/220x115.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK140x140.jpg</insecure_complete_url>
<name>square</name>
<path>/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK140x140.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK140x140.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK460x346-1.jpg</insecure_complete_url>
<name>triplet_one</name>
<path>/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK460x346-1.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK460x346-1.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-3.jpg</insecure_complete_url>
<name>triplet_three</name>
<path>/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-3.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-3.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-2.jpg</insecure_complete_url>
<name>triplet_two</name>
<path>/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-2.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-2.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_status>live</event_status>
<event_subdata>45</event_subdata>
<event_token>2A01</event_token>
<geo_data>
<latitude>40.7602619</latitude>
<longitude>-73.9932872</longitude>
</geo_data>
<is_seated>yes</is_seated>
<max_running_time>45</max_running_time>
<min_running_time>45</min_running_time>
<need_departure_date>no</need_departure_date>
<need_duration>no</need_duration>
<need_performance>yes</need_performance>
<postcode>10036</postcode>
<search_distance_km>0.0</search_distance_km>
<show_perf_time>yes</show_perf_time>
<source_code>broadway_inbound</source_code>
<source_desc>Ingresso (supplied by Broadway Inbound)</source_desc>
<venue_code>MINSKOFFTHEATRE</venue_code>
<venue_desc>Minskoff Theatre</venue_desc>
</event>
<event>
<area_code>WE</area_code>
<area_desc>West End</area_desc>
<bigup_value>196</bigup_value>
<city_code>london-uk</city_code>
<city_desc>London</city_desc>
<class>
<class_code>theatre</class_code>
<class_desc>Theatre</class_desc>
<is_main_class>yes</is_main_class>
<search_key>theatre/</search_key>
<subclass>
<is_main_subclass>yes</is_main_subclass>
<search_key>theatre/kids</search_key>
<subclass_code>kids</subclass_code>
<subclass_desc>Family</subclass_desc>
</subclass>
<subclass>
<is_main_subclass>no</is_main_subclass>
<search_key>theatre/musicals</search_key>
<subclass_code>musicals</subclass_code>
<subclass_desc>Musicals</subclass_desc>
</subclass>
</class>
<cost_range>
<best_value_offer>
<absolute_saving>14.25</absolute_saving>
<full_combined>86.75</full_combined>
<full_seatprice>72.5</full_seatprice>
<full_surcharge>14.25</full_surcharge>
<offer_combined>72.5</offer_combined>
<offer_seatprice>72.5</offer_seatprice>
<offer_surcharge>0.0</offer_surcharge>
<percentage_saving>16</percentage_saving>
</best_value_offer>
<max_combined>167.15</max_combined>
<max_saving_offer>
<absolute_saving>14.25</absolute_saving>
<full_combined>86.75</full_combined>
<full_seatprice>72.5</full_seatprice>
<full_surcharge>14.25</full_surcharge>
<offer_combined>72.5</offer_combined>
<offer_seatprice>72.5</offer_seatprice>
<offer_surcharge>0.0</offer_surcharge>
<percentage_saving>16</percentage_saving>
</max_saving_offer>
<max_seatprice>139.5</max_seatprice>
<max_surcharge>27.65</max_surcharge>
<min_combined>35.0</min_combined>
<min_cost_offer>
<absolute_saving>6.75</absolute_saving>
<full_combined>41.75</full_combined>
<full_seatprice>35.0</full_seatprice>
<full_surcharge>6.75</full_surcharge>
<offer_combined>35.0</offer_combined>
<offer_seatprice>35.0</offer_seatprice>
<offer_surcharge>0.0</offer_surcharge>
<percentage_saving>16</percentage_saving>
</min_cost_offer>
<min_seatprice>35.0</min_seatprice>
<min_surcharge>0.0</min_surcharge>
<no_singles_cost_range>
<best_value_offer>
<absolute_saving>14.25</absolute_saving>
<full_combined>86.75</full_combined>
<full_seatprice>72.5</full_seatprice>
<full_surcharge>14.25</full_surcharge>
<offer_combined>72.5</offer_combined>
<offer_seatprice>72.5</offer_seatprice>
<offer_surcharge>0.0</offer_surcharge>
<percentage_saving>16</percentage_saving>
</best_value_offer>
<max_combined>167.15</max_combined>
<max_saving_offer>
<absolute_saving>14.25</absolute_saving>
<full_combined>86.75</full_combined>
<full_seatprice>72.5</full_seatprice>
<full_surcharge>14.25</full_surcharge>
<offer_combined>72.5</offer_combined>
<offer_seatprice>72.5</offer_seatprice>
<offer_surcharge>0.0</offer_surcharge>
<percentage_saving>16</percentage_saving>
</max_saving_offer>
<max_seatprice>139.5</max_seatprice>
<max_surcharge>27.65</max_surcharge>
<min_combined>35.0</min_combined>
<min_cost_offer>
<absolute_saving>6.75</absolute_saving>
<full_combined>41.75</full_combined>
<full_seatprice>35.0</full_seatprice>
<full_surcharge>6.75</full_surcharge>
<offer_combined>35.0</offer_combined>
<offer_seatprice>35.0</offer_seatprice>
<offer_surcharge>0.0</offer_surcharge>
<percentage_saving>16</percentage_saving>
</min_cost_offer>
<min_seatprice>35.0</min_seatprice>
<min_surcharge>0.0</min_surcharge>
<quantity_options>
<valid_quantity>1</valid_quantity>
<valid_quantity>2</valid_quantity>
<valid_quantity>3</valid_quantity>
<valid_quantity>4</valid_quantity>
<valid_quantity>5</valid_quantity>
<valid_quantity>6</valid_quantity>
<valid_quantity>7</valid_quantity>
<valid_quantity>8</valid_quantity>
<valid_quantity>9</valid_quantity>
<valid_quantity>10</valid_quantity>
</quantity_options>
<range_currency>
<currency_code>gbp</currency_code>
<currency_factor>100</currency_factor>
<currency_number>826</currency_number>
<currency_places>2</currency_places>
<currency_post_symbol/>
<currency_pre_symbol>£</currency_pre_symbol>
</range_currency>
<top_price_offer>
<absolute_saving>7.13</absolute_saving>
<full_combined>86.75</full_combined>
<full_seatprice>72.5</full_seatprice>
<full_surcharge>14.25</full_surcharge>
<offer_combined>79.62</offer_combined>
<offer_seatprice>72.5</offer_seatprice>
<offer_surcharge>7.12</offer_surcharge>
<percentage_saving>8</percentage_saving>
</top_price_offer>
</no_singles_cost_range>
<quantity_options>
<valid_quantity>1</valid_quantity>
<valid_quantity>2</valid_quantity>
<valid_quantity>3</valid_quantity>
<valid_quantity>4</valid_quantity>
<valid_quantity>5</valid_quantity>
<valid_quantity>6</valid_quantity>
<valid_quantity>7</valid_quantity>
<valid_quantity>8</valid_quantity>
<valid_quantity>9</valid_quantity>
<valid_quantity>10</valid_quantity>
</quantity_options>
<range_currency>
<currency_code>gbp</currency_code>
<currency_factor>100</currency_factor>
<currency_number>826</currency_number>
<currency_places>2</currency_places>
<currency_post_symbol/>
<currency_pre_symbol>£</currency_pre_symbol>
</range_currency>
<top_price_offer>
<absolute_saving>7.13</absolute_saving>
<full_combined>86.75</full_combined>
<full_seatprice>72.5</full_seatprice>
<full_surcharge>14.25</full_surcharge>
<offer_combined>79.62</offer_combined>
<offer_seatprice>72.5</offer_seatprice>
<offer_surcharge>7.12</offer_surcharge>
<percentage_saving>8</percentage_saving>
</top_price_offer>
</cost_range>
<country_code>uk</country_code>
<country_desc>United Kingdom</country_desc>
<critic_review_percent>80</critic_review_percent>
<date_range_end>
<date_desc>Sun, 2nd October 2016</date_desc>
<date_utc_offset>3600</date_utc_offset>
<date_utc_seconds>1475415000</date_utc_seconds>
<date_yyyymmdd>20161002</date_yyyymmdd>
</date_range_end>
<date_range_start>
<date_desc>Sat, 31st October 2015</date_desc>
<date_utc_offset>0</date_utc_offset>
<date_utc_seconds>1446301800</date_utc_seconds>
<date_yyyymmdd>20151031</date_yyyymmdd>
</date_range_start>
<event_code>175</event_code>
<event_desc>The Lion King</event_desc>
<event_id>25DR</event_id>
<event_lingo>theatre</event_lingo>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/220x115.jpg</insecure_complete_url>
<name>landscape</name>
<path>/shared/event_media/atg_disney/WE/LYC_T/175/220x115.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/220x115.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/LionKing_700x300.jpg</insecure_complete_url>
<name>marquee</name>
<path>/shared/event_media/atg_disney/WE/LYC_T/175/LionKing_700x300.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/LionKing_700x300.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/The-Lyceum-Theatre_seating_plan.jpg</insecure_complete_url>
<name>seating_plan</name>
<path>/shared/event_media/atg_disney/WE/LYC_T/The-Lyceum-Theatre_seating_plan.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/The-Lyceum-Theatre_seating_plan.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/140x140.jpg</insecure_complete_url>
<name>square</name>
<path>/shared/event_media/atg_disney/WE/LYC_T/175/140x140.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/140x140.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-1.jpg</insecure_complete_url>
<name>triplet_one</name>
<path>/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-1.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-1.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-3.jpg</insecure_complete_url>
<name>triplet_three</name>
<path>/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-3.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-3.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_media>
<caption/>
<host>d1wx4w35ubmdix.cloudfront.net</host>
<insecure_complete_url>http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-2.jpg</insecure_complete_url>
<name>triplet_two</name>
<path>/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-2.jpg</path>
<secure_complete_url>https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-2.jpg</secure_complete_url>
<supports_http>yes</supports_http>
<supports_https>yes</supports_https>
</event_media>
<event_status>live</event_status>
<event_subdata/>
<event_token>25DR</event_token>
<geo_data>
<latitude>51.511784</latitude>
<longitude>-0.119622</longitude>
</geo_data>
<is_seated>yes</is_seated>
<need_departure_date>no</need_departure_date>
<need_duration>no</need_duration>
<need_performance>yes</need_performance>
<postcode>WC2E 7RQ</postcode>
<search_distance_km>0.0</search_distance_km>
<show_perf_time>yes</show_perf_time>
<source_code>atg_disney</source_code>
<source_desc>Ambassador Theatre Group</source_desc>
<venue_code>LYC/T</venue_code>
<venue_desc>The Lyceum</venue_desc>
</event>
</event_search_result>
7.4. Potential failure codes¶
- 1 - the supplied crypto block was not generated by “start_session”
- 2 - the requested “mime_text_type” was not a supported value
7.5. About Uniqueness of Event Ids/Tokens¶
Event can be uniquely identified by the tuple ( “s_src”, “s_area”, “s_ven”, “s_eve” ). All four parts are required to guarantee that an event is being uniquely specified, as the various codes are only defined to be unique within the namespace corresponding to the code above them in the data model. i.e. an event code is only guaranteed to be unique within a particular venue code, though a backend system may actually allocate unique codes for all events system-wide. An easier method than supplying these codes separately, however, is to use the “crypto_block” which is provided in the XML feed as part of the “full_query” element for each event. This method should only be used if the feed was run with the same user as the core is being run with.
Note
- List of all available events for the user if no search parameters are provided.
- Searching is not case sensitive.
Hint
Order: The search results are ordered alphabetically but may also be sorted in order of best sales by adding s_top (most sales over the last 48 hour period).