Display Message

## Content - [API Description](#api-description) - [API Parameters](#api-parameters) - [Input Parameters](#input-parameters) - [Output Parameters](#output-parameters) - [Error Codes](#error-codes) - [JSON Samples](#json-samples) - [Request 1](#request1) - [Request 2](#request2) - [Response 1](#response1) - [Response 2](#response2) Request for API key ## API Description | API Name | messages/get | | ----------- | -------------------------------------------------------------------- | | API Type | Query | | API Source | cache | | Description | Extracts the display message based on the code, locale and client id | ### Input Parameters ### HTTP Headers | Headers | Value | Description | | ------------------ | --------- | ---------------------------------------------------------------------------- | |Content-Type|application/json|| |apikey|*|An active SQ API Key for the FlightBooking Package| | Input Parameters | Data Type | Optional | Description | | ---------------- | ---------- | -------- | ------------------------------------------------------------------------ | | clientUUID | Number | No | Unique string representing this call | | request | JSONObject | No | | | code | String | Yes | Code for the display message, if not passed all message will be returned | | locale | String | No | Locale | ### Output Parameters | Output Parameters | Data Type | Description | | ------------------------------------------- | ---------- | ----------------------------------------------------------------------- | | status | String | “SUCCESS” / “FAILURE” | | code | Number | 200 if status is “SUCCESS”. Refer to Section 5 for possible error codes | | message | String | Populated and displayed only if status is “FAILURE” | | response | JSONObject | empty if status is “FAILURE”; displayed otherwise | |   channel | String | Channel ID returned on the basis of client Id passed in request | |   locale | String | Locale of the returned messages | |   displayMessageMap | JSONMap | | |     Key | JSONObject | Code will be returned as key of the Map | |       code | String | Code for the display message | |       message | String | Display Message | ### Error Codes | ErrorCodes | Message | Description | | ---------- | ------------------------------------------ | ----------------------------------------------- | | METADM0001 | Invalid request format. | If request structure is invalid | | METADM0003 | locale is mandatory. | If Locale is missing | | METADM0004 | No Message(s) found for the input provided | If no messages found for the channel and locale | ### Request1 ```json { "clientUUID": "734674ggjh4g-y743587hj-746358y", "apiVersion": "1", "request": { "locale": "en_GB" } } ``` ### Request2 ```json { "clientUUID": "734674ggjh4g-y743587hj-746358y", "apiVersion": "1", "request": { "code": "BKAGCN0051", "locale": "en_GB" } } ``` ### Response1 ```json { "status": "SUCCESS", "code": "200", "message": "", "clientUUID": "734674ggjh4g-y743587hj-746358y", "response": { "channel": "SQ", "locale": "en_GB", "displayMessageMap": { "BKAGCN0051": { "code": "BKAGCN0051", "message": "Your card has been challenged. Please bring the card to the airport or provide alternative card details" }, "BKAGCN0052": { "code": "BKAGCN0052", "message": "Your card has been challenged. Please bring the card to the airport or provide alternative card details" } } } } ``` ### Response2 ```json { "status": "SUCCESS", "code": "200", "message": "", "clientUUID": "734674ggjh4g-y743587hj-746358y", "response": { "channel": "SQ", "locale": "en_GB", "displayMessageMap": { "BKAGCN0051": { "code": "BKAGCN0051", "message": "Your card has been challenged. Please bring the card to the airport or provide alternative card details" } } } } ```