Search Special Event

This module has now been phased out and will no longer be supported.

The Search Special Event provides the client with static data relating to special events held within the GTA system. The API will provide a special event name along with the applicable dates for the event.

The XML Example XML Search Special Event request

The message below gives a sample of the expected elements needed by the API to execute a Search Special Event Request.

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
		<SearchSpecialEventRequest>
			<ItemDestination DestinationType="city" DestinationCode="BLQ" />
	  <DateRange>
     <FromDate>2004-09-28</FromDate> 
	  <ToDate>2004-10-03</ToDate>
    </DateRange>
		</SearchSpecialEventRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Special Event parameters

A Search Special Event request can contain optional attributes/parameters to filter the events returned.  The following lists the attributes/parameters that can be specified: -

Parameters

Description

ItemDestination

Mandatory. Used to return all events within the specified destination type (“area” or “city”) and destination code.

FromDate

Optional. Used to return all events from the specified date. If not specified today’s date will be used.

ToDate

Optional. Used to return all events to the specified date. If not specified all events from the FromDate will be returned.

SpecialEventName

Optional. If specified all events containing the given characters will be returned.

Note: Special Event Names are not case sensitive.

Example XML Search Special Event response

The XML message below gives a sample of that given by the API in response to a Search Special Event Request.

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200005">
	<ResponseDetails Language="en">
		<SearchSpecialEventResponse>
			<SpecialEventDetails>
						<City Code="BLQ"><![CDATA[Bologna]]></City>
					<DateRange>
						<FromDate>2004-09-28</FromDate>
						<ToDate>2004-10-03</ToDate>
					</DateRange>
					<Event><![CDATA[Ceramics Fair]]></Event>
				</SpecialEventDetail>
				<SpecialEventDetail>
					<City Code="BLQ"><![CDATA[Bologna]]></City>
					<DateRange>
						<FromDate>2004-09-22</FromDate>
						<ToDate>2004-10-10</ToDate>
					</DateRange>
					<Event><![CDATA[Anitique Fair]]></Event>
				</SpecialEventDetail>
			</SpecialEventDetails>
		</SearchSpecialEventResponse>
	</ResponseDetails>
</Response>

Search Special Event response parameters

A Search Special Event response will return the following for each event found for the request parameters: -

Parameter

Description

City

The city name.

In the language requested (if available).

 

Attribute

Description

 

Code

The unique city code held by GTA.

 

DateRange

The FromDate and ToDate for the event.

Event

The event description.

Docs Navigation