The *event\_search* method ========================== Returns a list of :term:`available events` based on a search criteria. Required inputs --------------- - Crypto_block from :ref:`Start Session call` OR - user_id and user_passwd 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 :term:`Backend System` - *s_area*: only events with an :term:`Area`. - *s_ven*: only events at a :term:`Venue` - *event_token_list*: returns from a list of :term:`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*: Example ------- Example input ~~~~~~~~~~~~~ .. code-block:: xml demo demo-password lion square landscape triplet_one triplet_two triplet_three triplet_four triplet_five marquee seating_plan Example output ~~~~~~~~~~~~~~ .. code-block:: xml no U_--vkpf9kC9pU5Ob-grofd1tGwcNPYj3ecsj3DY16jQkO0YWnDvmTKhsA3p_xUq7RLFyDc5-Rd1f6KqfuYIqgAFsCrPcyybcxWEO4r_Dm3LIEQyqrEjq89lr2PIn93DkwglY no NYCA NYCA 90 new_york-us New York theatre Theatre yes theatre/ yes theatre/kids kids Family no theatre/musicals musicals Musicals 229.08 229.08 0.0 84.33 84.33 0.0 229.08 229.08 0.0 84.33 84.33 0.0 1 2 3 4 5 6 7 8 9 10 gbp 100 826 2 £ 1 2 3 4 5 6 7 8 9 10 gbp 100 826 2 £ us United States of America Thu, 14th April 2016 -14400 1460674800 20160414 Tue, 3rd November 2015 -18000 1446595200 20151103 LIONKING2 The Lion King 2A01 theatre d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/220x115.jpg landscape /shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/220x115.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/220x115.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK140x140.jpg square /shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK140x140.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK140x140.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK460x346-1.jpg triplet_one /shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK460x346-1.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/LK460x346-1.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-3.jpg triplet_three /shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-3.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-3.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-2.jpg triplet_two /shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-2.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/broadway_inbound/NYCA/MINSKOFFTHEATRE/LIONKING2/460x346-2.jpg yes yes live 45 2A01 40.7602619 -73.9932872 yes 45 45 no no yes 10036 0.0 yes broadway_inbound Ingresso (supplied by Broadway Inbound) MINSKOFFTHEATRE Minskoff Theatre WE West End 196 london-uk London theatre Theatre yes theatre/ yes theatre/kids kids Family no theatre/musicals musicals Musicals 14.25 86.75 72.5 14.25 72.5 72.5 0.0 16 167.15 14.25 86.75 72.5 14.25 72.5 72.5 0.0 16 139.5 27.65 35.0 6.75 41.75 35.0 6.75 35.0 35.0 0.0 16 35.0 0.0 14.25 86.75 72.5 14.25 72.5 72.5 0.0 16 167.15 14.25 86.75 72.5 14.25 72.5 72.5 0.0 16 139.5 27.65 35.0 6.75 41.75 35.0 6.75 35.0 35.0 0.0 16 35.0 0.0 1 2 3 4 5 6 7 8 9 10 gbp 100 826 2 £ 7.13 86.75 72.5 14.25 79.62 72.5 7.12 8 1 2 3 4 5 6 7 8 9 10 gbp 100 826 2 £ 7.13 86.75 72.5 14.25 79.62 72.5 7.12 8 uk United Kingdom 80 Sun, 2nd October 2016 3600 1475415000 20161002 Sat, 31st October 2015 0 1446301800 20151031 175 The Lion King 25DR theatre d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/220x115.jpg landscape /shared/event_media/atg_disney/WE/LYC_T/175/220x115.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/220x115.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/LionKing_700x300.jpg marquee /shared/event_media/atg_disney/WE/LYC_T/175/LionKing_700x300.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/LionKing_700x300.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/The-Lyceum-Theatre_seating_plan.jpg seating_plan /shared/event_media/atg_disney/WE/LYC_T/The-Lyceum-Theatre_seating_plan.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/The-Lyceum-Theatre_seating_plan.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/140x140.jpg square /shared/event_media/atg_disney/WE/LYC_T/175/140x140.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/140x140.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-1.jpg triplet_one /shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-1.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-1.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-3.jpg triplet_three /shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-3.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-3.jpg yes yes d1wx4w35ubmdix.cloudfront.net http://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-2.jpg triplet_two /shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-2.jpg https://d1wx4w35ubmdix.cloudfront.net/shared/event_media/atg_disney/WE/LYC_T/175/lion-king460x346-2.jpg yes yes live 25DR 51.511784 -0.119622 yes no no yes WC2E 7RQ 0.0 yes atg_disney Ambassador Theatre Group LYC/T The Lyceum 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 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).