Skip to main content

Delete OSI

Delete OSI (Other Service Information) codes from an existing booking. This endpoint removes previously added OSI codes that are no longer needed or were added in error.


Endpoint

  • URL: /api/v1/flight/deleteosi
  • 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 IDs to delete

Example Request:

{
"system": "VN",
"bookingCode": "ABC123",
"osIs": [
"OSI001",
"OSI002"
]
}

Request Constraints & Business Rules

  • Only bookings that exist and are eligible for update can have OSI codes deleted.
  • The bookingCode must match an existing booking.
  • OSI IDs must reference existing OSI codes within the booking.
  • Some OSI codes may not be deletable depending on airline rules and booking status.
  • 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 IDs are validated against existing OSI codes in the booking.
  • All actions are logged and traceable.

Validation Questions

  • How do you retrieve OSI IDs from a booking to know which ones to delete?
  • Are there restrictions on which OSI codes can be deleted?
  • What happens if an OSI ID doesn't exist in the booking?
  • How are partial failures handled (some OSI codes deleted, others not)?

For integration support, see Contact Support.