Add Remark

Add remarks to an existing booking. Remarks are used to store additional information about the booking for internal reference or communication between agents.

---

Endpoint

• URL: /api/v1/flight/addremark
• Method: POST
• Auth Required: Yes (Bearer Token/X-API-KEY)
• Content-Type: application/json

---

Authentication

This endpoint requires a valid JWT Bearer token in the Authorization header:

Authorization: Bearer <access_token>

Obtain tokens via /api/v1/sign-in (POST) with your credentials.

---

Request Structure

Field	Type	Required	Description
system	string	No	Booking system code (e.g., VN, VJ, 1A)
bookingCode	string	No	Booking code (PNR)
remarks	array	No	List of remarks to add (see RemarkInfo)

RemarkInfo Object

Field	Type	Required	Description
remark	string	No	Remark content/value
public	boolean	No	Whether the remark is public or private

Example Request:

{
  "system": "VN",
  "bookingCode": "ABC123",
  "remarks": [
    {
      "remark": "VIP passenger - priority boarding",
      "public": false
    },
    {
      "remark": "Vegetarian meal requested",
      "public": true
    }
  ]
}

---

Request Constraints & Business Rules

• Only bookings that exist and are eligible for update can have remarks added.
• The bookingCode must match an existing booking.
• Public remarks may be visible to passengers or other systems.
• Private remarks are typically for internal agent use only.
• Remarks should not contain sensitive information like payment details.
• All changes are auditable via trackingId and trackingTime.

---

Response Structure

Field	Type	Nullable	Description
system	string	Yes	System name (e.g., VN, VJ, 1A)
status	boolean	No	true if successful, false if failed
error	object	Yes	Error details (if any)
description	string	Yes	Error description (if any)
trackingId	string	Yes	Tracking ID for request logs
trackingTime	string	Yes	Time for request tracking (ISO 8601 format)

Error Object

Field	Type	Nullable	Description
id	integer	No	Error code ID
message	string	Yes	Error message

Example Response:

{
  "system": "VN",
  "status": true,
  "error": null,
  "description": null,
  "trackingId": "abc-123",
  "trackingTime": "2024-06-01T12:00:00Z"
}

---

Error Codes

See Error Codes for details on possible error responses.

---

Security & Validation

• All input is validated for type and required fields.
• Only authenticated users can access this endpoint.
• Remark content is validated for appropriate length and content.
• All actions are logged and traceable.

---

Validation Questions

• What is the maximum length for remark content?
• Are there restrictions on remark content (e.g., no special characters)?
• How are public vs. private remarks handled differently in the system?
• Can remarks be updated after being added, or only deleted and re-added?

---

For integration support, see Contact Support.