Search Meal Type

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

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

Example XML Search Meal Type request

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

Source parameters

Please refer to the API Architecture document.

Search Meal Type parameters

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

Parameters

Description

MealTypeName

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

Note: Meal Type Names are not case sensitive.

MealTypeCode

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

Example XML Search Meal Type response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200002">
	<ResponseDetails Language="en">
		<SearchMealTypeResponse>
			<MealTypeDetails>
				<MealType Code="B"><![CDATA[Breakfast]]></MealType>
				<MealType Code="D"><![CDATA[Breakfast and dinner]]></MealType>
				<MealType Code="F"><![CDATA[Breakfast, lunch and dinner]]></MealType>
				<MealType Code="L"><![CDATA[Breakfast and lunch]]></MealType>
			</MealTypeDetails>
		</SearchMealTypeResponse>
	</ResponseDetails>
</Response>

Search Meal Type response parameters

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

Parameter

Description

MealType

The meal name.

In the language requested (if available).

 

Attribute

Description

 

Code

The unique meal type code held by GTA

Docs Navigation