Skip to main content

Add OSI

Add OSI (Other Service Information) codes to an existing booking. OSI codes are used to communicate special service information between airlines and travel agents.


Endpoint

  • URL: /api/v1/flight/addosi
  • 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

FieldTypeRequiredDescription
systemstringNoBooking system code (e.g., VN, VJ, 1A)
bookingCodestringNoBooking code (PNR)
osIsarrayNoList of OSI codes to add

Example Request:

{
"system": "VN",
"bookingCode": "ABC123",
"osIs": [
"VGML/NGUYEN VAN A",
"SPEQ/WHEELCHAIR"
]
}

Request Constraints & Business Rules

  • Only bookings that exist and are eligible for update can have OSI codes added.
  • The bookingCode must match an existing booking.
  • OSI codes must follow airline-specific formatting rules.
  • Duplicate OSI codes may be rejected by some systems.
  • All changes are auditable via trackingId and trackingTime.

Response Structure

FieldTypeNullableDescription
systemstringYesSystem name (e.g., VN, VJ, 1A)
statusbooleanNotrue if successful, false if failed
errorobjectYesError details (if any)
descriptionstringYesError description (if any)
trackingIdstringYesTracking ID for request logs
trackingTimestringYesTime for request tracking (ISO 8601 format)

Error Object

FieldTypeNullableDescription
idintegerNoError code ID
messagestringYesError 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.
  • OSI codes are validated against airline-specific rules.
  • All actions are logged and traceable.

Validation Questions

  • What are the supported OSI code formats for each airline system?
  • Are there restrictions on the number of OSI codes per booking?
  • What happens if the booking does not exist or is not eligible for update?
  • How are duplicate OSI codes handled?

For integration support, see Contact Support.