Search Remark

This module is being phased out and will no longer be supported in our new platform

Overview

The Search Remark provides the client with static data relating to pre-coded remark codes held within the GTA system. The API will provide a remark name along with the unique code used by GTA to identify the pre-coded remark.

Example XML Search Remark request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Remark 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>
		<SearchRemarkRequest ItemType="hotel">
		  <RemarkName>arrival</RemarkName> 
		</SearchRemarkRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Remark parameters

A Search Remark request can contain optional parameters to filter the remark codes returned.  The following lists the parameters that can be specified: -

Attribute

Description

ItemType

Mandatory. Identifies the type of item being processed. Must be one of “apartment” or “hotel”.

 

Parameters

Description

RemarkName

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

Note: Remark Names are not case sensitive.

RemarkCode

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

Example XML Search Remark response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200002">
	<ResponseDetails Language="en">
		<SearchRemarkResponse>
			<RemarkDetails>
				<Remark Code="EA"><![CDATA[Please note early arrival]]></Remark>
				<Remark Code="LA"><![CDATA[Please note late arrival]]></Remark>
			</RemarkDetails>
		</SearchRemarkResponse>
	</ResponseDetails>
</Response>

 Search Remark response parameters

A Search Remark response will return the following for each remark found for the request parameters: -

Parameter

Description

Remark

The remark name.

In the language requested (if available).

 

Attribute

Description

 

Code

The unique remark code held by GTA.

Docs Navigation