GET Note by context, contextId

Overview

Request

GET /[context]/[contextId]/Note

Request Information

Request Parameters

Name
Type
Requirement
Description
context
String
Mandatory 
Context in Request URI should be 'bookings', 'trips', 'accommodation', 'transfers', 'additionalServices' or 'sightseeing'
contextId
Integer
Mandatory 
ContextId in Request URI should be Booking ID, Trips ID, Accommodation ID, Transfers ID, AdditionalServices ID or Sightseeing ID

Response Information

Response Properties

Name
Type
Description
notes
List<Note>
Note list

Notes

Name
Type
Description
noteId
Integer
Note id
text
String
Note text
noteType
String
Type of note
paxName
String
Pax name
id
Integer
•  If it's a 'booking level' note then it will return booking Id
•  If it's a 'customer' level note then it will return participant id
•  If it's a 'component' level note then it will return component Id(Trip, Accommodation, Transfers etc.)

* Only applicable for these two endpoints:
•  GET /[context]/[contextId]/[context1]/[context1Id]/Note/[id]
•  GET /[context]/[contextId]/Note
type
String
•  An empty paxName and componentName will indicate a 'booking level' note
•  An empty componentName will indicate a 'customer' level note
•  All fields have values will indicate a 'component' level note

* Only applicable for these two endpoints:
•  GET /[context]/[contextId]/[context1]/[context1Id]/Note/[id]
•  GET /[context]/[contextId]/Note

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

{
  "notes": [
    {
      "noteId": 100,
      "text": "test note",
      "noteType": "Leader",
      "paxName": "john doe",
      "id": "id",
      "type": "type"
    },
    {
      "noteId": 100,
      "text": "test note",
      "noteType": "Leader",
      "paxName": "john doe",
      "id": "id",
      "type": "type"
    }
  ]
}