Add Special Keywords

Add Special Keywords (SK) to an existing booking. Special Keywords are used to communicate special handling instructions or requirements to airline systems and ground staff.

---

Endpoint

• URL: /api/v1/flight/addSK
• 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)
sKs	array	No	List of Special Keywords to add (see SKInfo)

SKInfo Object

Field	Type	Required	Description
sk	string	No	Special Keyword note/content
type	string	No	Special Keyword type (CORP, VVIP, CCIP)
passengerId	string	No	Passenger ID associated with SK (if applicable)

Example Request:

{
  "system": "VN",
  "bookingCode": "ABC123",
  "sKs": [
    {
      "sk": "Wheelchair assistance required",
      "type": "CORP"
    },
    {
      "sk": "VIP passenger - priority boarding",
      "type": "VVIP"
    }
  ]
}

---

Request Constraints & Business Rules

• Only bookings that exist and are eligible for update can have Special Keywords added.
• The bookingCode must match an existing booking.
• Special Keywords must be valid types (CORP, VVIP, CCIP) recognized by the airline system.
• The sk field contains the actual note/content for the Special Keyword.
• The type field categorizes the Special Keyword (CORP, VVIP, CCIP).
• CORP must be a real code provided by airline operation.
• 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.
• SK types are validated against airline system requirements (CORP, VVIP, CCIP).
• All actions are logged and traceable.

---

Validation Questions

• What Special Keyword types (CORP, VVIP, CCIP) are supported by each airline system?
• Are there restrictions on which SK types can be added to ticketed bookings?
• What content format is expected in the sk field for different types?
• What happens if an invalid SK type is provided?

---

For integration support, see Contact Support.