Search Breakfast Type

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

The Search Breakfast Type provides the client with static data relating to breakfast types held within the GTA system. The API will provide a breakfast type name along with the unique code used by GTA to identify the breakfast type.

 Example XML Search Breakfast Type request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Breakfast Type 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>
		<SearchBreakfastTypeRequest />
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Breakfast Type parameters

A Search Breakfast Type request can contain optional parameters to filter the breakfast types returned.  The following lists the parameters that can be specified: -

Parameters

Description

BreakfastTypeName

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

Note: Breakfast Type Names are not case sensitive.

BreakfastTypeCode

Optional. If specified the breakfast type details for the single code will be returned.

 Example XML Search Breakfast Type response

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

<?xml version="1.0" encoding="UTF-8"?>

<Response ResponseReference="200002">

       <ResponseDetails Language="en">

              <SearchBreakfastTypeResponse>

                     <BreakfastTypeDetails>

                           <BreakfastType Code="A"><![CDATA[American]]></BreakfastType>

                           <BreakfastType Code="B"><![CDATA[Cold buffet]]></BreakfastType>

                           <BreakfastType Code="C"><![CDATA[Continental]]></BreakfastType>

                           <BreakfastType Code="E"><![CDATA[English]]></BreakfastType>

                     </BreakfastTypeDetails>

              </SearchBreakfastTypeResponse>

       </ResponseDetails>

</Response>

Search Breakfast Type response parameters

A Search Breakfast Type response will return the following for each breakfast type found for the request parameters: -

Parameter

Description

BreakfastType

The breakfast name.

In the language requested (if available).

 

Attribute

Description

 

Code

The unique breakfast type code held by GTA

Docs Navigation