FABRequestResponse
Each request message or response message from FAB is an example of a FABRequestResponse object and as such has the following structure:
| Attribute or element | Mandatory? | Definition | Note |
|---|---|---|---|
@Target | Yes | test or production | Controls which FAB system is used. Bookings against “test” are not real. |
@Version | Yes | Must be set to 2002A | - |
SyndicatorInfo@SyndicatorId | Yes | String of syndicatorId | Used for authN/authZ |
SyndicatorInfo@SyndicatorPassword | Yes | String of syndicator password | Used for authN/authZ |
SessionInfo@CreateNewSession | Yes | true or false | Controls whether to create a new FAB session, see API concepts section on sessions. |
SessionInfo@FABSessionId | Yes for all responses. Yes for requests if continuing a session. | String | See API concepts section on sessions |
ConsumersContext@Reference | No | consisting of any string that the syndicator wishes to attach to this request/response. | - |
ConsumersContext/Parameter[*]@Name | No | Key pair value variation of Reference | Element can be repeated up to a total of 10 |
ConsumersContext/Parameter[*]@Value | No | Key pair value variation of Reference | Element can be repeated up to a total of 10 |
Warnings | No | List of Warning that are relevant to current request or response | Note that for FAB_BasketRS warnings may also be set a level down so check both locations, see FAB__BasketRS |
Warnings/Warning[*] | No | Warning text | - |
Errors | No | List of Error that are relevant to current request or response | Note that for FAB_BasketRS errors may also be set a level down so check both locations, see FAB_BasketRS |
Errors/Error[*]@ErrorText | Yes if Error element is being set | a generic human readable description of the error | Likely not appropriate to expose to consumers |
Errors/Error[*]@ErrorCode | Yes if Error element is being set | string error code | see Error Codes |
ConfigOverride@NormalisationCurrency | No | ISO 4217 alphabetic currency that response prices should be normalised (converted) to | Should be used consistently throughout all stages of a journey |
CurrencyConversionRates | No | Contains a list of Rate that can be used for currency conversion in place of spot rate | - |
CurrencyConversionRates/Rate[*]@FromCurrency | Yes if Rate element is being set | ISO 4217 alphabetic currency. From currency for rate | - |
CurrencyConversionRates/Rate[*]@ToCurrency | Yes if Rate element is being set | ISO 4217 alphabetic currency. To currency for rate | - |
CurrencyConversionRates/Rate[*]@Rate | Yes if Rate element is being set | Float greater than zero. Rate | - |
Languages | No | List of Language codes in priority order descending. Indicates preferred content language. If unset or none of the listed languages are supported by the supplier then English ( EN) will be used. | Also see example page for this feature |
Languages/Language[*] | Yes if Languages element is being set | ISO 639-1 two letter language code, e.g EN | - |
Last modified February 24, 2023