openapi: 3.2.0 info: title: NewSkies-Digital-Api Booking/passengers API version: 4.8.6.23 description: Navitaire Digital Api servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground security: - JWT: [] tags: - name: booking/passengers paths: /api/nsk/v1/booking/passengers: get: tags: - booking/passengers summary: Gets the collection of passengers on the booking. description: 'GraphQL endpoint: passengers' operationId: nsk_v1_booking_passengers_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPassenger' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications: get: tags: - booking/passengers summary: Gets passenger travel notifications for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotifications' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTravelNotification' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Creates a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotificationsAdd' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_post parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 requestBody: x-name: request description: The passenger travel notification create request. content: application/json: schema: $ref: '#/components/schemas/TravelNotificationCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}: get: tags: - booking/passengers summary: Gets a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotification' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTravelNotification' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/passengers summary: Updates a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotificationsSet' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_put parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The travel notification edit request. content: application/json: schema: $ref: '#/components/schemas/TravelNotificationEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotificationsModify' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_patch parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The delta mapper travel notification edit request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelNotificationEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotificationsDelete' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_delete parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}/events: get: tags: - booking/passengers summary: Gets notification events for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationEvents' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_events_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Adds a notification event to a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationEventsAdd' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_events_post parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The notification event create request. content: application/json: schema: $ref: '#/components/schemas/NotificationEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}/events/{eventType}: get: tags: - booking/passengers summary: Get a notification event for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationEvent' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_events_eventType_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: eventType in: path required: true description: "The event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" schema: $ref: '#/components/schemas/NotificationEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNotificationEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a notification event from a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationEventsDelete' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_events_eventType_delete parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: eventType in: path required: true description: "The notification event type. \nEnumeration values: 0 = DepartureDelay, 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" schema: $ref: '#/components/schemas/NotificationEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}/timedEvents: get: tags: - booking/passengers summary: Gets notification timed events for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEvents' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationTimedEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Adds a notification timed event to a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEventsAdd' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_post parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The notification timed even create request. content: application/json: schema: $ref: '#/components/schemas/NotificationTimedEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' ? /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType} : get: tags: - booking/passengers summary: Get a notification timed event for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEvent' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNotificationTimedEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/passengers summary: Updates a notification timed event for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEventsSet' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_put parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 requestBody: x-name: request description: The updated notification timed event request. content: application/json: schema: $ref: '#/components/schemas/NotificationTimedEventEditRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a notification timed event from a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEventsDelete' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_delete parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The notification timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}: get: tags: - booking/passengers summary: Gets a specific passenger on the booking. description: 'GraphQL endpoint: passenger' operationId: nsk_v1_booking_passengers_passengerKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassenger' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/passengers/{passengerKey}: put: tags: - booking/passengers summary: Updates a specific passenger on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoints: passengerSetv4, passengersSetBatchv2' operationId: nsk_v3_booking_passengers_passengerKey_put parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: waiveNameChangeFees in: query description: Waive the name change fees. schema: type: - boolean - 'null' x-position: 2 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender of all the travel documents in the\npassengers[passengerKey].travelDocuments list in the booking model. The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The modified passenger request. content: application/json: schema: $ref: '#/components/schemas/PassengerBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Updated: description: The passenger has been updated. value: data: null Valid declared gender mapped to a different binary gender: description: Example response for successfully updating or modifying a passenger with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Example response for successfully updating or modifying a passenger with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: Example response when the declared gender in the request is more than 2 characters. value: errors: - id: null code: PassengerInformation.DeclaredGender:StringLengthAttribute message: The field PassengerInformation must be a string with a maximum length of 2. type: Validation details: member: DeclaredGender model: PassengerInformation validation: StringLengthAttribute rawMessage: The field PassengerInformation must be a string with a maximum length of 2. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: Example response when the declared gender in the request is inactive or non-existent. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Passenger John Doe has an invalid Declared Gender K. type: Validation details: message: Passenger John Doe has an invalid Declared Gender K. rawMessage: Passenger John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a specific passenger on the booking. description: 'Please note, the API will perform validation for the same properties that are on both the PATCH request and the existing passenger. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoints: passengerModifyv4, passengersModifyBatchv2' operationId: nsk_v3_booking_passengers_passengerKey_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: waiveNameChangeFees in: query description: Waive the name change fee. If unprovided, defaults to the configuration value. schema: type: - boolean - 'null' x-position: 2 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender of all the travel documents in the\npassengers[passengerKey].travelDocuments list in the booking model. The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The patched passenger request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPassengerBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Updated: description: The passenger has been updated. value: data: null Valid declared gender mapped to a different binary gender: description: Example response for successfully updating or modifying a passenger with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Example response for successfully updating or modifying a passenger with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: Example response when the declared gender in the request is more than 2 characters. value: errors: - id: null code: core:Validation:InvalidJsonSchema message: 'Invalid Json Schema. Line: #/info - NotOneOf.' type: Validation details: null rawMessage: 'Invalid Json Schema. Line: #/info - NotOneOf.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: Example response when the declared gender in the request is inactive or non-existent. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Passenger John Doe has an invalid Declared Gender K. type: Validation details: message: Passenger John Doe has an invalid Declared Gender K. rawMessage: Passenger John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null First passenger is not allowed to be TBA and is set as TBA: description: Example error when first passenger is not allowed to be TBA and its first or last name is set to "TBA". Please see GET /settings/booking/passenger for the configuration. value: errors: - id: null code: nsk:GroupBooking:GroupNameUpdateNotAllowed message: The first Pax is not allowed to be listed as TBA. type: Validation details: null rawMessage: The first Pax is not allowed to be listed as TBA. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Passengers are not allowed to be TBA and at least one passenger is set to TBA: description: Example error when passengers are not allowed to be TBA and at least one passenger's first or last name is set to "TBA". Please see GET /settings/booking/passenger for the configuration. value: errors: - id: null code: nsk:GroupBooking:GroupNameUpdateNotAllowed message: No passengers are allowed to be listed as TBA. type: Validation details: null rawMessage: No passengers are allowed to be listed as TBA. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/addresses: get: tags: - booking/passengers summary: Gets the collection of addresses from a specific passenger. description: Gets the collection of addresses from a specific passenger. operationId: nsk_v1_booking_passengers_passengerKey_addresses_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerAddress' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/addresses: post: tags: - booking/passengers summary: Creates a new address for a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerAddressAddv2' operationId: nsk_v2_booking_passengers_passengerKey_addresses_post parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 requestBody: x-name: request description: The new address request. content: application/json: schema: $ref: '#/components/schemas/PassengerAddressCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/addresses/{addressKey}: get: tags: - booking/passengers summary: Gets a specific address from a specific passenger. description: 'GraphQL endpoint: passengerAddress' operationId: nsk_v1_booking_passengers_passengerKey_addresses_addressKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: addressKey in: path required: true description: The unique address key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerAddress' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/passengers/{passengerKey}/addresses/{addressKey}: put: tags: - booking/passengers summary: Updates a specific address on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerAddressSetv3' operationId: nsk_v3_booking_passengers_passengerKey_addresses_addressKey_put parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: addressKey in: path required: true description: The unique address key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified address. content: application/json: schema: $ref: '#/components/schemas/PassengerAddressEditRequestv2' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a specific address on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerAddressModifyv3' operationId: nsk_v3_booking_passengers_passengerKey_addresses_addressKey_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: addressKey in: path required: true description: The unique address key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched address. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPassengerAddressEditRequestv2' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/addresses/{addressKey}: delete: tags: - booking/passengers summary: Deletes a specific address on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerAddressDeletev2' operationId: nsk_v2_booking_passengers_passengerKey_addresses_addressKey_delete parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: addressKey in: path required: true description: The unique address key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/baggage: get: tags: - booking/passengers summary: Gets all the baggage for a specified passenger. description: Gets all the baggage for a specified passenger. operationId: nsk_v1_booking_passengers_passengerKey_baggage_get parameters: - name: passengerKey in: path required: true description: The unique identifier for the passenger to get baggage for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerBag' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/baggage/{baggageKey}: get: tags: - booking/passengers summary: Retrieve a single bag from a specific passenger. description: 'GraphQL endpoint: passengerBag' operationId: nsk_v1_booking_passengers_passengerKey_baggage_baggageKey_get parameters: - name: passengerKey in: path required: true description: The passenger key for the passenger to retrieve from. schema: type: string x-position: 1 - name: baggageKey in: path required: true description: The bag key for the bag to retrieve. schema: type: string x-position: 2 responses: '200': description: OK. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerBag' '404': description: Bag was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/baggage/{baggageKey}/events: get: tags: - booking/passengers summary: Retrieves events for a specific passenger baggage. description: 'GraphQL endpoint: passengerBagEvents' operationId: nsk_v1_booking_passengers_passengerKey_baggage_baggageKey_events_get parameters: - name: passengerKey in: path required: true description: Passenger key. schema: type: string x-position: 1 - name: baggageKey in: path required: true description: Baggage key. schema: type: string x-position: 2 - name: StartDate in: query description: "Start date. If no start date is provided, the start date defaults to the current UTC-based date.\n " schema: type: - string - 'null' format: date-time x-position: 3 - name: EndDate in: query description: "End date. If no end date is provided, the end date defaults to the current UTC-based date.\n " schema: type: - string - 'null' format: date-time x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBaggageEventResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: 'Creates event information for a specific passenger baggage. A successful call immediately creates the event and does not require the booking to be committed.' description: 'GraphQL endpoint: passengerBagEventAdd' operationId: nsk_v1_booking_passengers_passengerKey_baggage_baggageKey_events_post parameters: - name: passengerKey in: path required: true description: Passenger key. schema: type: string x-position: 1 - name: baggageKey in: path required: true description: Baggage key. schema: type: string x-position: 2 requestBody: x-name: request description: Baggage event create request. content: application/json: schema: $ref: '#/components/schemas/BaggageEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/baggage/{baggageKey}/events/{baggageEventKey}: get: tags: - booking/passengers summary: Retrieves information for a specific passenger baggage event. description: 'GraphQL endpoint: passengerBagEvent' operationId: nsk_v1_booking_passengers_passengerKey_baggage_baggageKey_events_baggageEventKey_get parameters: - name: passengerKey in: path required: true description: Passenger key. schema: type: string x-position: 1 - name: baggageKey in: path required: true description: Baggage key. schema: type: string x-position: 2 - name: baggageEventKey in: path required: true description: Baggage event key. schema: type: string x-position: 3 - name: StartDate in: query description: "Start date. If no start date is provided, the start date defaults to the current UTC-based date.\n " schema: type: - string - 'null' format: date-time x-position: 4 - name: EndDate in: query description: "End date. If no end date is provided, the end date defaults to the current UTC-based date.\n " schema: type: - string - 'null' format: date-time x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBaggageEvent' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/breakdown: get: tags: - booking/passengers summary: Gets a specific passenger price breakdown by passenger key. description: 'GraphQL endpoint: passengerBreakdown' operationId: nsk_v1_booking_passengers_passengerKey_breakdown_get parameters: - name: passengerKey in: path required: true description: The specific passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerPriceBreakdown' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/documents: get: tags: - booking/passengers summary: Gets a specific passenger's collection of travel documents. description: Gets a specific passenger's collection of travel documents. operationId: nsk_v1_booking_passengers_passengerKey_documents_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerTravelDocument' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/documents: post: tags: - booking/passengers summary: Create a new travel document for a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerTravelDocumentsAddv2' operationId: nsk_v2_booking_passengers_passengerKey_documents_post parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender in the passengers[passengerKey] as well as the gender of the other\ntravel documents in the passengers[passengerKey].travelDocuments list in the booking model. The value defaults to\ntrue if not specified.\n " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The new travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerTravelDocumentCreatedResponse' examples: Passenger Travel Document Created: description: The passenger travel document has been created. value: data: passengerTravelDocumentKey: UCFVUyEg With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: passengerTravelDocumentKey: UCFVUyEg '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/documents/{travelDocumentKey}: get: tags: - booking/passengers summary: Gets a specific passenger's specific travel document. description: 'GraphQL endpoint: passengerTravelDocuments' operationId: nsk_v1_booking_passengers_passengerKey_documents_travelDocumentKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerTravelDocument' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/documents/{travelDocumentKey}: put: tags: - booking/passengers summary: Updates a specific passenger's travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerTravelDocumentsSetv2' operationId: nsk_v2_booking_passengers_passengerKey_documents_travelDocumentKey_put parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender in the passengers[passengerKey] as well as the gender of the other\ntravel documents in the passengers[passengerKey].travelDocuments list in the booking model. The value defaults to\ntrue if not specified.\n " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The modified travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Travel Document Updated: description: The passenger travel document has been updated. value: data: null With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a specific passenger's travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerTravelDocumentsModifyv2' operationId: nsk_v2_booking_passengers_passengerKey_documents_travelDocumentKey_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender in the passengers[passengerKey] as well as the gender of the other\ntravel documents in the passengers[passengerKey].travelDocuments list in the booking model. The value defaults to\ntrue if not specified.\n " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The patched travel document. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelDocumentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Travel Document Updated: description: The passenger travel document has been updated. value: data: null With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a specific passenger's specific travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerTravelDocumentsDeletev2' operationId: nsk_v2_booking_passengers_passengerKey_documents_travelDocumentKey_delete parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/documents/check: get: tags: - booking/passengers summary: Gets the document check status for a specific passenger if there are any. description: 'Requires a committed booking in state. Requires document check to be enabled in government security configuration. Performs document check and returns the results as documentCheckStatus. More detailed information is intentionally not provided for security reasons. The designers of the client application will need to determine what to do with the different responses, in most cases the passenger will need to be assisted by an airport agent. For more specific requirements check the following endpoint GET/api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements. For configuration options please contact your CSDM. For full documentation see https://developer.navitaire.com/documentation/dotrez-api/how-to/adc. GraphQL endpoint: passengerDocumentCheck' operationId: nsk_v1_booking_passengers_passengerKey_documents_check_get parameters: - name: passengerKey in: path required: true description: The key of the passenger to perform the document check on. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDocumentCheckResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/emdCoupons: get: tags: - booking/passengers summary: Gets the collection of passenger EMD coupons for a specific passenger. description: 'GraphQL endpoint: passengerEmdCoupons' operationId: nsk_v1_booking_passengers_passengerKey_emdCoupons_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerEmdCoupon' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/emdCoupons/{passengerEmdCouponKey}: get: tags: - booking/passengers summary: Gets a specific passenger EMD coupon for a specific passenger. description: 'GraphQL endpoint: passengerEmdCoupon' operationId: nsk_v1_booking_passengers_passengerKey_emdCoupons_passengerEmdCouponKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: passengerEmdCouponKey in: path required: true description: The unique passenger EMD coupon key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerEmdCoupon' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/fees: get: tags: - booking/passengers summary: Gets all fees for a specific passenger, based upon the given passenger key. description: 'GraphQL endpoint: passengerFees' operationId: nsk_v1_booking_passengers_passengerKey_fees_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerFee' examples: Retrieve passenger fees response: description: Example response for successfully retrieving the passenger fees. value: data: - type: 7 ssrCode: null ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: true isConfirmingExternal: false code: NFSF detail: null passengerFeeKey: MCEwITc- override: false flightReference: null note: b createdDate: '2025-03-26T05:24:42.7610199+00:00' isProtected: false serviceCharges: - amount: 0.0 code: NFSF detail: for free type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.0 ticketCode: NSF - type: 5 ssrCode: null ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: true isConfirmingExternal: false code: CHF1 detail: 26Mar NV2033 SLCDEN passengerFeeKey: MCExITU- override: false flightReference: 20250326 NV2033 SLCDEN note: a createdDate: '2025-03-26T05:27:52.1473296+00:00' isProtected: true serviceCharges: - amount: 50.0 code: CHF1 detail: Change Fee type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 50.0 ticketCode: CHF No passenger fees response: description: Example response when there are no fees associated with the passenger. value: data: [] '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No booking in state: description: Example error when there is no booking in state. value: errors: - id: 4d8dbf9a-ea54-6c63-e755-da5c0328543d code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid passenger key: description: Example error when the passenger key is invalid or does not exist in the booking in state. value: errors: - id: 1c2e93af-10dd-3da9-56ae-d1e50e731906 code: nsk:Exceptions:InvalidKey message: The identifier 'passengerKey' with value 'MCF' is invalid. type: Validation details: null rawMessage: The identifier 'passengerKey' with value 'MCF' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/booking/passengers/{passengerKey}/fees/{passengerFeeKey}: get: tags: - booking/passengers summary: Gets a specific fee for a specific passenger, based upon the given keys. description: 'GraphQL endpoint: passengerFee' operationId: nsk_v1_booking_passengers_passengerKey_fees_passengerFeeKey_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: passengerFeeKey in: path required: true description: The passenger fee key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerFee' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/fees/nameChange: delete: tags: - booking/passengers summary: Waives the name change fee of the specified passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerNameChangeFeeDelete' operationId: nsk_v1_booking_passengers_passengerKey_fees_nameChange_delete parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/fees/quote: get: tags: - booking/passengers summary: Gets the override fee quote of a new fee. description: 'GraphQL endpoint: overrideNewFeeQuote' operationId: nsk_v1_booking_passengers_passengerKey_fees_quote_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: FeeCode in: query description: "The fee code used to identify the fee being overridden.\n \nCurrently, only manually-added fees are supported for quoting new fee overrides.\nThese fee types are:\n- Service Fee\n- Non-Flight Service Fee\n- Penalty Fee\n- Spoilage Fee\n " schema: type: - string - 'null' maxLength: 6 minLength: 0 x-position: 2 - name: PricingMode in: query description: "Indicates if fees are to be paid in points or with currency\n \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" schema: $ref: '#/components/schemas/FeePricingMode' x-position: 3 - name: OriginStation in: query description: "Originating station code of the booking where the fee will be applied.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 4 - name: Amount in: query description: "The override amount.\n " schema: type: - number - 'null' format: decimal x-position: 5 - name: CollectedCurrencyCode in: query description: "The collected currency code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGetOverrideFeeQuoteResponse' examples: Retrieve Override Fee Quote Response: description: Example response for successfully retrieving the override fee quote response. value: data: feeOverrideCharges: - amount: 100.0 code: NFSF detail: Non Flight type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 100.0 ticketCode: NSF '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: Example Error if there is no booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Passenger Key: description: Example Error if passenger key is invalid. value: errors: - id: 2987bed7-5690-5050-55e9-819b8551b344 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'PassengerKey' with value 'MCFBASDFRFQ-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Currency Code: description: Example Error if the currency code is invalid. value: errors: - id: 10daf3f4-82c2-cf99-21ba-169fadae0b10 code: nsk:Validation:UnknownSellCurrencyCode message: nsk:Validation:UnknownSellCurrencyCode type: Validation details: currencyCode: SDK rawMessage: The currency code SDK does not exist or is not active. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Fee Key: description: Example Error if fee key is invalid. value: errors: - id: ea9e908c-8979-85d8-c9ed-886014d6fc46 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'FeeKey' with value 'MT21XF' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Fee Code: description: Example Error if the fee code is not allowed to be quoted. value: errors: - id: bf7c1a48-a4bf-ddf7-2413-93959ba6a3b3 code: nsk-server:FeeCalculation message: nsk-server:FeeCalculation type: Validation details: null rawMessage: Cannot quote overrides of type NameChangeFee for new fees. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Null Fee Code: description: Example Error if the fee code is null value: errors: - id: 6b34775e-d264-f3a6-4034-62daf6699617 code: GetNewOverrideFeeQuoteRequestBase.FeeCode:RequiredAttribute message: The GetNewOverrideFeeQuoteRequestBase field is required. type: Validation details: validation: RequiredAttribute model: GetNewOverrideFeeQuoteRequestBase member: FeeCode rawMessage: The GetNewOverrideFeeQuoteRequestBase field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Null Fee Amount: description: Example Error if the fee amount is null value: errors: - id: 6b34775e-d264-f3a6-4034-62daf6699617 code: GetNewOverrideFeeQuoteRequestBase.FeeCode:RequiredAttribute message: The GetNewOverrideFeeQuoteRequestBase field is required. type: Validation details: validation: RequiredAttribute model: GetNewOverrideFeeQuoteRequestBase member: Amount rawMessage: The GetNewOverrideFeeQuoteRequestBase field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Allow Negative Fees Role Setting Off: description: Example Error if the fee amount is negative or the fee type is not allowed to override, and the role setting is turned off. value: errors: - id: a49a0074-9b6d-9e30-83c3-1c21a56d748c code: nsk:Validation:RoleSettingsProhibit message: nsk:Validation:RoleSettingsProhibit type: Validation details: null rawMessage: Role settings prohibit a negative fee. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Inactive Fees: description: Example Error if the agent attempted to sell inactive fees. value: errors: - id: bee189bc-edfc-263b-edc1-33cbf8b709cf code: nsk:Fee:NotFound message: nsk:Fee:NotFound type: Validation details: null rawMessage: The fee was not found. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Unauthorized Overriding of Service Fees: description: Example Error if the agent is not authorized to override a service fee. value: errors: - id: 7911302f-46af-3dc8-5714-b2823fec853d code: nsk-server:AuthorizationSSRNotAllowed message: Agent is not authorized to override fees. type: Validation details: message: Agent is not authorized to override fees. rawMessage: Agent is not authorized to override fees. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Unauthorized Selling of Service Fees: description: Example Error if the agent is not authorized to sell a service fee. value: errors: - id: cfdacd38-5e2c-ab09-9fce-86722e945f0b code: nsk-server:AuthorizationServiceFeeNotAllowed message: Agent is not authorized to sell service fee FLO. type: Validation details: message: Agent is not authorized to sell service fee FLO. rawMessage: Agent is not authorized to sell service fee FLO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/infant: get: tags: - booking/passengers summary: Gets a specific passenger's infant. description: 'GraphQL endpoint: passengerInfant' operationId: nsk_v1_booking_passengers_passengerKey_infant_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerInfant' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/passengers/{passengerKey}/infant: post: tags: - booking/passengers summary: Creates an infant on a specific passenger. description: 'If the booking in state contains a passive segment, an infant will not be created on the passive segment for the passenger. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerInfantAddv3' operationId: nsk_v3_booking_passengers_passengerKey_infant_post parameters: - name: passengerKey in: path required: true description: The unique identifier of the passenger to which the infant will be added. schema: type: string x-position: 1 requestBody: x-name: request description: The new infant. content: application/json: schema: $ref: '#/components/schemas/PassengerInfantCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Valid declared gender mapped to the same binary gender: description: Successfully creating a passenger infant with a valid declared gender mapped to the same binary gender (i.e. Male to Undisclosed or Unspecified). value: data: null Valid declared gender mapped to a different binary gender: description: Successfully creating a passenger infant with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Successfully creating a passenger infant with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: The declared gender in the request is more than 2 characters. value: errors: - id: null code: PassengerInfantCreateRequest.DeclaredGender:StringLengthAttribute message: The field PassengerInfantCreateRequest must be a string with a maximum length of 2. type: Validation details: member: DeclaredGender model: PassengerInfantCreateRequest validation: StringLengthAttribute rawMessage: The field PassengerInfantCreateRequest must be a string with a maximum length of 2. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: The declared gender in the request is inactive or not configured in the system. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Infant John Doe has an invalid Declared Gender K. type: Validation details: message: Infant John Doe has an invalid Declared Gender K. rawMessage: Infant John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/passengers summary: Updates an infant on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantSetv3' operationId: nsk_v3_booking_passengers_passengerKey_infant_put parameters: - name: passengerKey in: path required: true description: The unique identifier of the passenger associated with the infant. schema: type: string x-position: 1 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender of\nall the travel documents in the passengers[passengerKey].infant.travelDocuments list in the booking model. The\nvalue defaults to true if not specified.\n " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The modified infant. content: application/json: schema: $ref: '#/components/schemas/Infant' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Valid declared gender mapped to the same binary gender: description: Successfully updating or modifying a passenger infant with a valid declared gender mapped to the same binary gender (i.e. Male to Undisclosed or Unspecified). value: data: null Valid declared gender mapped to a different binary gender: description: Successfully updating or modifying a passenger infant with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Successfully updating or modifying a passenger infant with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null Mismatching passenger infant and travel document declared gender: description: Successfully updating or modifying a passenger infant with a mismatching declared gender (Female) and travel document declared gender (Undisclosed). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value U. New Binary Gender: Male' status: 1 details: null - code: null type: FailedTravelDocValidation value: Infant (Doe, Justine) Gender doesn't match Travel Document (US, P, 1234567890) Gender status: 0 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: The declared gender in the request is more than 2 characters. value: errors: - id: null code: PassengerInfant.DeclaredGender:StringLengthAttribute message: The field PassengerInfant must be a string with a maximum length of 2. type: Validation details: member: DeclaredGender model: PassengerInfant validation: StringLengthAttribute rawMessage: The field PassengerInfant must be a string with a maximum length of 2. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: The declared gender in the request is inactive or not configured in the system. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Infant John Doe has an invalid Declared Gender K. type: Validation details: message: Infant John Doe has an invalid Declared Gender K. rawMessage: Infant John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/infant: patch: tags: - booking/passengers summary: Patches an infant on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantModifyv2' operationId: nsk_v2_booking_passengers_passengerKey_infant_patch parameters: - name: passengerKey in: path required: true description: The unique identifier of the passenger associated with the infant. schema: type: string x-position: 1 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender of\nall the travel documents in the passengers[passengerKey].infant.travelDocuments list in the booking model. The\nvalue defaults to true if not specified.\n " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The patched infant. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfInfant' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Valid declared gender mapped to the same binary gender: description: Successfully updating or modifying a passenger infant with a valid declared gender mapped to the same binary gender (i.e. Male to Undisclosed or Unspecified). value: data: null Valid declared gender mapped to a different binary gender: description: Successfully updating or modifying a passenger infant with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Successfully updating or modifying a passenger infant with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null Mismatching passenger infant and travel document declared gender: description: Successfully updating or modifying a passenger infant with a mismatching declared gender (Female) and travel document declared gender (Undisclosed). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value U. New Binary Gender: Male' status: 1 details: null - code: null type: FailedTravelDocValidation value: Infant (Doe, Justine) Gender doesn't match Travel Document (US, P, 1234567890) Gender status: 0 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: The declared gender in the request is more than 2 characters. value: errors: - id: null code: core:Validation:InvalidJsonSchema message: 'Invalid Json Schema. Line: #/declaredGender - NoTypeValidates.' type: Validation details: null rawMessage: 'Invalid Json Schema. Line: #/declaredGender - NoTypeValidates.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: The declared gender in the request is inactive or not configured in the system. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Infant John Doe has an invalid Declared Gender K. type: Validation details: message: Infant John Doe has an invalid Declared Gender K. rawMessage: Infant John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes an infant from a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantDeletev2' operationId: nsk_v2_booking_passengers_passengerKey_infant_delete parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/infant/documents: get: tags: - booking/passengers summary: Gets a specific passenger infant's collection of travel documents. description: Gets a specific passenger infant's collection of travel documents. operationId: nsk_v1_booking_passengers_passengerKey_infant_documents_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerTravelDocument' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/infant/documents: post: tags: - booking/passengers summary: Create a new travel document for a specific passenger infant. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantTravelDocumentsAddv2' operationId: nsk_v2_booking_passengers_passengerKey_infant_documents_post parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender in\nthe passengers[passengerKey].infant as well as the gender of the other travel documents in the\npassengers[passengerKey].infant.travelDocuments list in the booking model. The value defaults to true if not\nspecified.\n " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The new travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerTravelDocumentCreatedResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/infant/documents/{travelDocumentKey}: get: tags: - booking/passengers summary: Gets a specific passenger infant's specific travel document. description: 'GraphQL endpoint: passengerInfantTravelDocuments' operationId: nsk_v1_booking_passengers_passengerKey_infant_documents_travelDocumentKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerTravelDocument' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/infant/documents/{travelDocumentKey}: put: tags: - booking/passengers summary: Updates a specific passenger infant travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantTravelDocumentsSetv2' operationId: nsk_v2_booking_passengers_passengerKey_infant_documents_travelDocumentKey_put parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender in\nthe passengers[passengerKey].infant as well as the gender of the other travel documents in the\npassengers[passengerKey].infant.travelDocuments list in the booking model. The value defaults to true if not\nspecified.\n " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The modified travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a specific passenger infant travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantTravelDocumentsModifyv2' operationId: nsk_v2_booking_passengers_passengerKey_infant_documents_travelDocumentKey_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel documents' gender. This will update the gender in\nthe passengers[passengerKey].infant as well as the gender of the other travel documents in the\npassengers[passengerKey].infant.travelDocuments list in the booking model. The value defaults to true if not\nspecified.\n " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The patched travel document. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelDocumentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a specific passenger infant specific travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantTravelDocumentsDeletev2' operationId: nsk_v2_booking_passengers_passengerKey_infant_documents_travelDocumentKey_delete parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/infant/documents/check: get: tags: - booking/passengers summary: Gets the document check status for a specific passenger's infant if there are any. description: 'Requires a committed booking in state. Requires document check to be enabled in government security configuration. Performs document check and returns the results as documentCheckStatus. More detailed information is intentionally not provided for security reasons. The designers of the client application will need to determine what to do with the different responses, in most cases the passenger will need to be assisted by an airport agent. For more specific requirements check the following endpoint GET/api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements. For configuration options please contact your CSDM. For full documentation see https://developer.navitaire.com/documentation/dotrez-api/how-to/adc. GraphQL endpoint: passengerInfantDocumentCheck' operationId: nsk_v1_booking_passengers_passengerKey_infant_documents_check_get parameters: - name: passengerKey in: path required: true description: The key of the passenger to perform the infant document check on. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDocumentCheckResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/passengerTypeCode: patch: tags: - booking/passengers summary: Patches a specific passenger to the given passenger type. description: 'NOTE: The date of birth doesn''t need to be updated if the passenger''s current date of birth still falls within the new passenger type''s age restriction. This could also cause a repricing on the booking. In addition, changing the passenger type will change the passenger key as well. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerTypeCodeModify' operationId: nsk_v1_booking_passengers_passengerKey_passengerTypeCode_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\ndocuments' gender. This will update the gender of all the travel documents in the\npassengers[passengerKey].travelDocuments list in the booking model. The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The passenger type request containing the new passenger type. content: application/json: schema: $ref: '#/components/schemas/PassengerTypeCodeEditRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerKeyResponse' examples: Passenger Type Code Modified: description: The passenger type code has been modified. value: data: oldPassengerKey: MCFBRFQ- newPassengerKey: MCFTTlI- With mismatching passenger travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: oldPassengerKey: MCFBRFQ- newPassengerKey: MCFTTlI- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/seats: get: tags: - booking/passengers summary: Gets all seats associated with a passenger. description: 'GraphQL endpoint: seatPassengerv2' operationId: nsk_v2_booking_passengers_passengerKey_seats_get parameters: - name: passengerKey in: path required: true description: Passengers to get seats for. schema: type: string x-position: 1 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerSeat' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/seats/{unitKey}: delete: tags: - booking/passengers summary: Deletes a seat assignment from a specific passenger on the booking in state. description: 'GraphQL endpoint: seatDelete' operationId: nsk_v1_booking_passengers_passengerKey_seats_unitKey_delete parameters: - name: passengerKey in: path required: true description: The key for the passenger whose seat assignment is to be deleted. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unique unit key. schema: type: string x-position: 2 - name: WaiveFee in: query description: "The flag indicating to waive the seat fees if permissions permit.\n " schema: type: - boolean - 'null' x-position: 3 - name: IgnoreSeatSsrs in: query description: "Flag indicating whether to ignore seat SSR's.\n " schema: type: - boolean - 'null' x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/seats/{unitKey}: get: tags: - booking/passengers summary: Gets passenger seat by key. description: 'GraphQL endpoint: seatv2' operationId: nsk_v2_booking_passengers_passengerKey_seats_unitKey_get parameters: - name: passengerKey in: path required: true description: Unique passenger key. schema: type: string x-position: 1 - name: unitKey in: path required: true description: Unique unit key. schema: type: string x-position: 2 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSeat' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Adds a seat assignment to a specific passenger on the booking in state. description: 'This endpoint actively checks whether the passenger has a seat. If the passenger does have a seat, it will delete the current seat the passenger occupies and add the requested one. This may result in slightly slower response times. GraphQL endpoint: seatAddv2' operationId: nsk_v2_booking_passengers_passengerKey_seats_unitKey_post parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key. schema: type: string x-position: 2 requestBody: x-name: request description: The add seat request. content: application/json: schema: $ref: '#/components/schemas/AddSeatRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/seats/{unitKey}/quote: get: tags: - booking/passengers summary: Retrieves a seat fee quote for a specific passenger. description: 'GraphQL endpoint: seatFeeQuote' operationId: nsk_v1_booking_passengers_passengerKey_seats_unitKey_quote_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key. schema: type: string x-position: 2 - name: InventoryControlType in: query description: "The type of hold placed on seats.\n \nEnumeration values: 0 = Session, 1 = None" schema: $ref: '#/components/schemas/UnitInventoryControlType' x-position: 3 - name: IgnoreSeatSSRs in: query description: "Determines whether or not SSRs associated with the seat will be ignored when determining\nunit availability.\n " schema: type: - boolean - 'null' x-position: 4 - name: SeatAssignmentMode in: query description: "The seat assignment mode can affect available units in seat maps and whether or not\nseat fees are charged based on channel type, role settings, customer programs\nand/or class of service.\n \nEnumeration values: 0 = AutoDetermine, 1 = PreSeatAssignment, 2 = WebCheckIn" schema: $ref: '#/components/schemas/SeatAssignmentMode' x-position: 5 - name: MonetaryOnly in: query description: "Indicates whether the fee to be priced is to be priced in money or points.\n " schema: type: - boolean - 'null' x-position: 6 - name: CollectedCurrencyCode in: query description: "Optional currency code. If different than the booking currency code,\nfees in that currency will be returned if the conversion exists in the system.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSeatFee' examples: Retrieve Seat Fee Quote Response: description: Successful retrieval of the seat fee information of the specified passenger. value: data: type: 9 ssrCode: null ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: true isConfirmingExternal: false passengerKey: MCFBRFQ- code: JSF detail: null passengerFeeKey: MCEwITk- override: false flightReference: 20241111 NV5670 SLCBOS note: null createdDate: '2026-07-09T05:55:13.949142Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: null type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: PHP foreignAmount: 1435.0 ticketCode: JSF '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: No booking was put into state before retrieving a seat fee quote. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Passenger Key: description: The passenger key does not exist in the booking in state. value: errors: - id: 2987bed7-5690-5050-55e9-819b8551b344 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'PassengerKey' with value 'MCFBASDFRFQ-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Unit Key: description: The unit key is invalid and cannot be decoded properly. value: errors: - id: 2987bed7-5690-5050-55e9-819b8551b344 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'unitKey' with value 'MS3NIP5DHgO9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Unconfigured Collected Currency Code: description: The collected currency code does not exist in the system or no conversion rate is found for the collected currency code. value: errors: - id: 62be6a4f-507b-a109-e082-2a2a1dd6a63e code: nsk-server:CurrencyConversionRateNotFound message: nsk-server:CurrencyConversionRateNotFound type: Information details: null rawMessage: No currency conversion rate found from USD to YER. You need to add this rate in Management Application. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Collected Currency Code Length: description: The collected currency code exceeds the maximum length. value: errors: - id: 169290f3-341a-c49e-f84c-c8049929b79f code: SeatFeeQuoteRequestv2.CollectedCurrencyCode:StringLengthAttribute message: The field SeatFeeQuoteRequestv2 must be a string with a maximum length of 3. type: Validation details: validation: StringLengthAttribute model: SeatFeeQuoteRequestv2 member: CollectedCurrencyCode rawMessage: The field SeatFeeQuoteRequestv2 must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Retrieves a seat fee quote for a specific passenger. description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. GraphQL endpoint: passengerSeatFeeQuote' operationId: nsk_v1_booking_passengers_passengerKey_seats_unitKey_quote_post parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key. schema: type: string x-position: 2 requestBody: x-name: request description: The seat fee quote request. content: application/json: schema: $ref: '#/components/schemas/SeatFeeQuoteRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSeatFee' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/passengers/{passengerKey}/ssrs/{ssrCode}/price: get: tags: - booking/passengers summary: Gets an SSR price quote on the booking in state. description: 'Requires a booking in state. GraphQL endpoint: passengerSsrPriceQuotes' operationId: nsk_v1_booking_passengers_passengerKey_ssrs_ssrCode_price_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: ssrCode in: path required: true description: The ssr code. schema: type: string x-position: 2 - name: collectedCurrencyCode in: query description: The collected currency code. schema: type: - string - 'null' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsrPrice' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/passengers/{passengerKey}/ssrs/priceDetails: post: tags: - booking/passengers summary: Gets multiple SSR price quotes for the booking in state. description: 'Requires a booking in state. Due to the complexity of the request parameters, we use POST to allow for the request body to be used, even though this is actually a GET operation. This endpoint is related to the booking/ssrs/availability POST endpoint. This is a deep call to get the price details for specific SSR''s for a specific passenger, while the availability endpoint is a shallow call to get the available SSR''s and their associated prices. Submitting a request with SSR codes not found in the ssr availability call may not yield results from this endpoint. GraphQL endpoint: passengerSsrPriceQuotesBatch' operationId: nsk_v1_booking_passengers_passengerKey_ssrs_priceDetails_post parameters: - name: passengerKey in: path required: true description: The passenger key. These can be found on the /booking GET endpoint response. schema: type: string x-position: 1 requestBody: x-name: request description: The multiple SSR price request for a single passenger. content: application/json: schema: $ref: '#/components/schemas/PassengerSsrPriceRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfPassengerSsrPrice' examples: Retrieve SSR price details: description: Example response for successfully retrieving the passenger specific SSR price details. value: data: wchr: - passengerKey: MCFBRFQ- ssrPrices: - key: TlZ_NTY2NX4gfn5TTEN_MDMvMDUvMjAyNiAxNzowMH5CT1N_MDMvMDUvMjAyNiAyMzowMH5_ passengerFee: type: 6 ssrCode: WCHR ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: SSRF2 detail: An SSR detail passengerFeeKey: MCEwITY- override: false flightReference: ABC123 note: An SSR note createdDate: '2026-07-09T05:55:13.7433955Z' isProtected: false serviceCharges: - amount: 18.0 code: SSRF2 detail: SSR Fee type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 18.0 ticketCode: SF2 ssrType: 4 snep: - passengerKey: MCFBRFQ- ssrPrices: - key: TlZ_NTY2NX4gfn5TTEN_MDMvMDUvMjAyNiAxNzowMH5CT1N_MDMvMDUvMjAyNiAyMzowMH5_ passengerFee: type: 6 ssrCode: SNEP ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: SSR detail: An SSR detail passengerFeeKey: MCEwITY- override: false flightReference: ABC123 note: An SSR note createdDate: '2026-07-09T05:55:13.7434388Z' isProtected: false serviceCharges: - amount: 0.0 code: SSR detail: Sfor free type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: EUR foreignAmount: 0.0 ticketCode: SSR ssrType: 3 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: Example Error if there is no booking in state. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Passenger Key: description: Example Error if passenger key is invalid. value: errors: - id: null code: nsk:Passenger:InvalidPassengerKey message: nsk:Passenger:InvalidPassengerKey type: Validation details: null rawMessage: The passenger key LDbRYqMVpNpe1y5UQkFRYqc is not valid for this booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid SSR Code: description: Example Error if the SSR code is invalid. value: errors: - id: null code: nsk:Ssrs:InvalidCode message: nsk:Ssrs:InvalidCode type: Validation details: null rawMessage: The SSR code TRSH is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Currency Code: description: Example Error if the currency code is invalid. value: errors: - id: null code: nsk:Currency:InvalidCurrencyCode message: nsk:Currency:InvalidCurrencyCode type: Validation details: null rawMessage: The currency code Q is either invalid or inactive in the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Too many requested ssr codes: description: The number of SSR codes in the request exceeds the system defined maximum amount. value: errors: - id: null code: PassengerSsrPriceRequest.SsrCodes:MaxLengthAttribute message: The field PassengerSsrPriceRequest must be a string or array type with a maximum length of '20'. type: Validation details: null rawMessage: The field PassengerSsrPriceRequest must be a string or array type with a maximum length of '20'. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No SSR price details: description: Example response when there are no SSR price details available. value: data: null /api/nsk/v1/booking/passengers/{passengerKey}/voucher: get: tags: - booking/passengers summary: 'Gets information regarding a specific voucher code and passenger. Returns what a voucher can pay for a given passenger.' description: 'GraphQL endpoint: voucherByPassenger' operationId: nsk_v1_booking_passengers_passengerKey_voucher_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: ReferenceCode in: query description: "The voucher reference code.\n " schema: type: - string - 'null' maxLength: 20 minLength: 1 x-position: 2 - name: OverrideRestrictions in: query description: "Override restrictions. Defaults to false.\n " schema: type: - boolean - 'null' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherInformation' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/baggage/group: get: tags: - booking/passengers summary: Gets baggage group membership for all passengers on booking in state, or predicts group membership if no current groups exist description: 'Call this before adding a bag to see what baggage group an added bag will be added to. Respects newskies configuration of baggage groups. Related endpoints: - PUT api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/group - GET /api/nsk/v1/booking/baggageAllowances - baggage allowances can have weight sharing by group behavior GraphQL endpoint: passengersBagGroups' operationId: nsk_v1_booking_passengers_baggage_group_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBaggageGroupMembership' examples: Retrieve baggage groups: description: Possible response for a booking with two segments and two passengers value: data: - baggageGroupNumber: 3 passengerKeys: - MCFBRFQ- - MSFBRFQ- segmentKeys: - TlZ_MTIyMX4gfn5KRkt_MDYvMDMvMjAyNSAwMTowMH5TTEN_MDYvMDMvMjAyNSAwMjowMH5_ - baggageGroupNumber: 1 passengerKeys: - MCFBRFQ- segmentKeys: - TlZ_MjAwOH4gfn5TTEN_MDYvMDUvMjAyNSAwODowMH5KRkt_MDYvMDUvMjAyNSAxNDowMH5_ - baggageGroupNumber: 2 passengerKeys: - MSFBRFQ- segmentKeys: - TlZ_MTIyMX4gfn5KRkt_MDYvMDMvMjAyNSAwMTowMH5TTEN_MDYvMDMvMjAyNSAwMjowMH5_ '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: No booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: No booking was found in session, cannot perform operation. type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. deprecated: true post: tags: - booking/passengers summary: 'Gets baggage group membership for selected passengers, or predicts group membership if no current groups exist. Structured as a POST but behaves as a GET.' description: 'Call this before adding a bag to see what baggage group an added bag will be added to. Respects newskies configuration of baggage groups. Related endpoints: - PUT api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/group - GET /api/nsk/v1/booking/baggageAllowances - baggage allowances can have weight sharing by group behavior GraphQL endpoint: passengersBagGroupsList' operationId: nsk_v1_booking_passengers_baggage_group_post requestBody: x-name: passengerKeys description: List of passenger keys. If none are provided, gets all passengers on in-state booking. content: application/json: schema: type: array items: type: string required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBaggageGroupMembership' examples: Retrieve baggage groups: description: Possible response for a booking with two segments and two passengers value: data: - baggageGroupNumber: 3 passengerKeys: - MCFBRFQ- - MSFBRFQ- segmentKeys: - TlZ_MTIyMX4gfn5KRkt_MDYvMDMvMjAyNSAwMTowMH5TTEN_MDYvMDMvMjAyNSAwMjowMH5_ - baggageGroupNumber: 1 passengerKeys: - MCFBRFQ- segmentKeys: - TlZ_MjAwOH4gfn5TTEN_MDYvMDUvMjAyNSAwODowMH5KRkt_MDYvMDUvMjAyNSAxNDowMH5_ - baggageGroupNumber: 2 passengerKeys: - MSFBRFQ- segmentKeys: - TlZ_MTIyMX4gfn5KRkt_MDYvMDMvMjAyNSAwMTowMH5TTEN_MDYvMDMvMjAyNSAwMjowMH5_ '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: No booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: No booking was found in session, cannot perform operation. type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v1/booking/passengers/breakdown: get: tags: - booking/passengers summary: Gets all the passenger price breakdowns. description: Gets all the passenger price breakdowns. operationId: nsk_v1_booking_passengers_breakdown_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPassengerPriceBreakdown' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/breakdown/byType: get: tags: - booking/passengers summary: Gets all the passenger price breakdown by passenger type. description: Gets all the passenger price breakdown by passenger type. operationId: nsk_v1_booking_passengers_breakdown_byType_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPassengerTypePriceBreakdown' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/groupBooking: put: tags: - booking/passengers summary: Updates the collection of un-named or TBA passengers on the booking. description: 'When Enforce Standard Group Booking setting is true, group name is required and un-named or TBA passengers will be setup with First Name: TBA, Middle Name: Sequential Numeric, Last Name = Group Name. When the setting is false, group name is not required and passengers will be setup with First Name: Sequential Alphabetic, Last Name: TBA IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengersGroupBookingSet' operationId: nsk_v1_booking_passengers_groupBooking_put responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPassenger' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' components: schemas: EmdTypeCode: type: integer description: "Represents the EMD type code options.\n \n\n0 = None\n1 = Associated\n2 = StandAlone" x-enumNames: - None - Associated - StandAlone enum: - 0 - 1 - 2 NotificationTimedEventEditRequest: type: object description: "A travel notification timed event edit request.\n " additionalProperties: false properties: minutesToEvent: type: integer description: "The minutes to the event.\n " format: int32 PassengerSsrPrice: type: object description: "Passenger ssr price model.\n " additionalProperties: false properties: passengerKey: type: - string - 'null' description: "The passenger key.\n " ssrPrices: type: - array - 'null' description: "The list of ssr prices associated with the passenger.\n " items: $ref: '#/components/schemas/SsrPrice' IJsonResponseOfIListOfPassengerFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PassengerFee' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' SsrPrice: type: object description: "Ssr price model.\n " additionalProperties: false properties: key: type: - string - 'null' description: "This key can be either a journey or segment key depending on the ssr type.\n " passengerFee: description: "The passenger fee.\n " $ref: '#/components/schemas/PassengerFee' ssrType: description: "The type of ssr.\n " $ref: '#/components/schemas/TravelComponent' PassengerProgram: type: object description: "Model representing a passenger program.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ levelCode: type: - string - 'null' description: "The program level code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ number: type: - string - 'null' description: "The program number.\n " maxLength: 32 minLength: 0 GetOverrideFeeQuoteResponse: type: object description: "Defines the get override fee quote response.\n " additionalProperties: false properties: feeOverrideCharges: type: - array - 'null' description: "The list of service charges that contain the fee override amounts.\n " items: $ref: '#/components/schemas/ServiceCharge' Passenger: type: object description: "Model information representing a passenger on a journey.\n " additionalProperties: false required: - passengerTypeCode properties: customerNumber: type: - string - 'null' description: "The passenger customer number.\n " maxLength: 20 minLength: 0 name: description: "The passenger's name.\n " $ref: '#/components/schemas/Name' discountCode: type: - string - 'null' description: "The discount code associated with the passenger type.\n " maxLength: 8 minLength: 0 program: description: "The passenger programs.\n " $ref: '#/components/schemas/PassengerProgram' info: description: "Additional passenger information.\n " $ref: '#/components/schemas/PassengerInformation' passengerKey: type: - string - 'null' description: "The unique passenger identifier key.\n " passengerAlternateKey: type: - string - 'null' description: "The passenger alternate key is used to identify a passenger post commit of the booking.\n " fees: type: - array - 'null' description: "Fees.\n " items: $ref: '#/components/schemas/PassengerFee' passengerTypeCode: type: string description: "The passenger type code.\n " minLength: 1 bags: type: - array - 'null' description: "Passenger bags.\n " items: $ref: '#/components/schemas/PassengerBag' infant: description: "The optional infant associated with this passenger.\n " $ref: '#/components/schemas/PassengerInfant' travelDocuments: type: - array - 'null' description: "The collection of passenger travel Documents.\n " items: $ref: '#/components/schemas/PassengerTravelDocument' addresses: type: - array - 'null' description: "The collection of passenger addresses.\n " items: $ref: '#/components/schemas/PassengerAddress' weightCategory: description: "The weight category assigned to this passenger.\n " $ref: '#/components/schemas/WeightCategory' emdCoupons: type: - array - 'null' description: "The passenger EMD coupons.\n " items: $ref: '#/components/schemas/PassengerEmdCoupon' DocumentCheckStatus: type: integer description: "Represents the status of a document after performing a third party document check.\nMore detailed information is intentionally not provided for security reasons.\n \n\n0 = None\n1 = Ok\n2 = Conditional\n3 = NotOk" x-enumNames: - None - Ok - Conditional - NotOk enum: - 0 - 1 - 2 - 3 BaggageEventResponse: type: object description: "Represents the response from retrieving baggage events.\n " additionalProperties: false properties: events: type: - array - 'null' description: "List of baggage events.\n " items: $ref: '#/components/schemas/BaggageEvent' IJsonResponseOfPassengerEmdCoupon: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerEmdCoupon' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerSeatFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerSeatFee' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerPriceBreakdown: type: object description: "Defines the individual passenger-level pricing breakdown.\n " additionalProperties: false properties: services: description: "The charge breakdown of the service fees.\n " $ref: '#/components/schemas/ChargeBreakdown' specialServices: description: "The charge breakdown of the special service requests.\n " $ref: '#/components/schemas/ChargeBreakdown' seats: description: "The charge breakdown of seat fees.\n " $ref: '#/components/schemas/ChargeBreakdown' upgrades: description: "The charge breakdown of upgrade fees.\n " $ref: '#/components/schemas/ChargeBreakdown' spoilage: description: "The charge breakdown of spoilage fees.\n " $ref: '#/components/schemas/ChargeBreakdown' nameChanges: description: "The charge breakdown of name change fees.\n " $ref: '#/components/schemas/ChargeBreakdown' convenience: description: "The charge breakdown of convenience fees.\n " $ref: '#/components/schemas/ChargeBreakdown' infant: description: "The charge breakdown of infant fees.\n " $ref: '#/components/schemas/ChargeBreakdown' totalCost: type: - number - 'null' description: "The total cost for the passenger.\nThese values are only populated by NewSkies after a booking commit\n " format: decimal passengerKey: type: - string - 'null' description: "The unique passenger number.\n " PassengerSeatFee: type: object description: "Passenger seat fee model.\n " additionalProperties: false required: - code properties: type: description: "The fee type.\n " $ref: '#/components/schemas/FeeType' ssrCode: type: - string - 'null' description: "The SSR code.\n " ssrNumber: type: integer description: "The fee SSR number.\n " paymentNumber: type: integer description: "The fee payment number.\n " isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: - string - 'null' description: "The fee detail.\n " maxLength: 32 minLength: 0 passengerFeeKey: type: - string - 'null' description: "The passenger fee key.\n " override: type: boolean description: "The fee override.\n " flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 note: type: - string - 'null' description: "The fee notes.\n " maxLength: 128 minLength: 0 createdDate: type: - string - 'null' description: "The created date for the fee.\n " format: date-time isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: - array - 'null' description: "The list of service charges for the fee.\n " items: $ref: '#/components/schemas/ServiceCharge' passengerKey: type: - string - 'null' description: "The passenger key.\n " VoucherStatus: type: integer description: "Defines the status of a voucher.\n \n\n0 = Available\n1 = Void\n2 = Redeemed\n3 = Expired" x-enumNames: - Available - Void - Redeemed - Expired enum: - 0 - 1 - 2 - 3 NotificationTimedEventCreateRequest: type: object description: "A travel notification timed event create request.\n " additionalProperties: false required: - type properties: minutesToEvent: type: integer description: "The minutes to the event.\n " format: int32 type: description: "The travel notification timed event type.\n " $ref: '#/components/schemas/NotificationTimedEventType' SeatPreference: type: object description: "Represents a single seat preference.\n " additionalProperties: false required: - seatMapCode - value properties: seatMapCode: type: string description: "The seat map code (ex. 'SMOKING').\n " maxLength: 8 minLength: 0 value: type: string description: "The seat map value (ex. 'TRUE').\n " maxLength: 8 minLength: 0 status: description: "Defines if the seat preference is met, not met or unknown.\n " $ref: '#/components/schemas/SeatPreferenceStatus' PassengerEmdCoupon: type: object description: "Model information for the passenger EMD coupon.\n " additionalProperties: false properties: status: description: "The EMD coupon status.\n " $ref: '#/components/schemas/EmdCouponStatus' emdTypeCode: description: "The EMD type code.\n " $ref: '#/components/schemas/EmdTypeCode' passengerEmdCouponKey: type: - string - 'null' description: "The unique identifier for a passenger EMD coupon.\n " emdNumber: type: - string - 'null' description: "The 13 digit passenger EMD number, assigned after the EMD has been issued.\n " maxLength: 13 minLength: 0 couponNumber: type: integer description: "The EMD coupon number, assigned after the EMD has been issued.\nTODO: In SkySpeed this is 0-4 only\n " maximum: 32767.0 minimum: 0.0 optionalServiceInformation: description: "The optional service information.\n " $ref: '#/components/schemas/OptionalServiceInformation' salesDate: type: - string - 'null' description: "The sale date.\n " format: date-time flightReference: type: - string - 'null' description: "The EMD flight reference.\n " maxLength: 22 minLength: 0 receivedFromSystemCode: type: - string - 'null' description: "The received from system code.\n " maxLength: 3 minLength: 0 numberOfServices: type: integer description: "The number of services.\n " maximum: 32767.0 minimum: 1.0 feeType: description: "The EMD related fee type.\n " $ref: '#/components/schemas/FeeType' feeKey: type: - string - 'null' description: "The EMD related fee key.\n " ssrCode: type: - string - 'null' description: "The EMD related SSR code.\n " maxLength: 4 minLength: 0 ssrNumber: type: - integer - 'null' description: "The EMD related SSR code.\n " CollectType: type: integer description: "Used to identify the collect type of a service charge.\n \n\n0 = SellerChargeable\n1 = ExternalChargeable\n2 = SellerNonChargeable\n3 = ExternalNonChargeable\n4 = ExternalChargeableImmediate" x-enumNames: - SellerChargeable - ExternalChargeable - SellerNonChargeable - ExternalNonChargeable - ExternalChargeableImmediate enum: - 0 - 1 - 2 - 3 - 4 AddSeatRequest: type: object description: "Defines update seat request.\n " additionalProperties: false properties: collectedCurrencyCode: type: - string - 'null' description: "Optional Currency code if different than booking currency code.\n " maxLength: 3 minLength: 0 inventoryControl: description: "Indicates the type of hold placed on a unit.\n " $ref: '#/components/schemas/UnitInventoryControlType' seatAssignmentMode: description: "The seat assignment mode.\n " $ref: '#/components/schemas/SeatAssignmentMode' feePricingMode: description: "Indicates if the seat is to be sold in currency or points.\n " $ref: '#/components/schemas/FeePricingMode' waiveFee: type: - boolean - 'null' description: "The flag indicating to waive the seat fees if permissions permit.\n " ignoreSeatSsrs: type: - boolean - 'null' description: "Flag indicating whether to ignore seat SSR's.\n " journeyKey: type: - string - 'null' description: "The journey key.\n " IJsonResponseOfIListOfPassengerTravelDocument: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PassengerTravelDocument' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' DeltaMapperOfInfant: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: dateOfBirth: type: - string - 'null' description: "The date of birth of the infant.\n " format: date-time gender: description: "The gender of the passenger.\n " $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 declaredGender: type: - string - 'null' description: "The infant's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 nationality: type: - string - 'null' description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 IJsonResponseOfPassengerTravelDocument: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerTravelDocument' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerTravelDocumentCreatedResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerTravelDocumentCreatedResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfNotificationEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/NotificationEvent' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerAddressCreateRequest: type: object description: "Defines a passenger address create request.\n " additionalProperties: false properties: companyName: type: - string - 'null' description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 phone: type: - string - 'null' description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 stationCode: type: - string - 'null' description: "Station code associated with this address.\n " maxLength: 3 minLength: 3 emailAddress: type: - string - 'null' description: "The email address associated with the address.\n " cultureCode: type: - string - 'null' description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 refusedContact: type: - boolean - 'null' description: "Indicates if the passenger refused to enter a contact.\n " lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 status: description: "The addresses APIS status.\n " $ref: '#/components/schemas/ApisAddressStatus' ChargeType: type: integer description: "The type of a service charge.\n \n\n0 = FarePrice\n1 = Discount\n2 = IncludedTravelFee\n3 = IncludedTax\n4 = TravelFee\n5 = Tax\n6 = ServiceCharge\n7 = PromotionDiscount\n8 = ConnectionAdjustmentAmount\n9 = AddOnsPrice\n10 = FarePoints\n11 = DiscountPoints\n16 = IncludedAddOnsFee\n17 = AddOnsFee\n18 = AddOnsMarkup\n19 = FareSurcharge\n21 = AddOnsCancelFee\n22 = Calculated\n23 = Note\n24 = Points\n25 = DynamicFareAdjustment" x-enumNames: - FarePrice - Discount - IncludedTravelFee - IncludedTax - TravelFee - Tax - ServiceCharge - PromotionDiscount - ConnectionAdjustmentAmount - AddOnsPrice - FarePoints - DiscountPoints - IncludedAddOnsFee - AddOnsFee - AddOnsMarkup - FareSurcharge - AddOnsCancelFee - Calculated - Note - Points - DynamicFareAdjustment enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 16 - 17 - 18 - 19 - 21 - 22 - 23 - 24 - 25 IJsonResponseOfPassengerInfant: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerInfant' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerTravelDocumentCreatedResponse: type: object description: "Model representing a passenger travel document.\n " additionalProperties: false properties: passengerTravelDocumentKey: type: - string - 'null' description: "A key that uniquely identifies a travel document in the context of a specific passenger.\n " NotificationTimedEventType: type: integer description: "Represents the type of timed notification event type for a travel notification event.\nThese are events that have an associated property minutes to event.\n \n\n0 = Departure\n1 = Arrival" x-enumNames: - Departure - Arrival enum: - 0 - 1 IJsonResponseOfIDictionaryOfStringAndPassenger: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - object - 'null' description: "The payload data.\n " additionalProperties: $ref: '#/components/schemas/Passenger' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerTypeCodeEditRequest: type: object description: "A model for a request to update the passenger type code.\n " additionalProperties: false required: - passengerTypeCode properties: passengerTypeCode: type: string description: "The new passenger type code to update the passenger to.\n " minLength: 1 dateOfBirth: type: - string - 'null' description: "The date of birth for the passenger.\n " format: date-time gender: description: "The new gender of the passenger.\nOnly required if GDPR is enabled.\n " $ref: '#/components/schemas/Gender' PassengerInfantCreateRequest: type: object description: "Model representing infant data that can be set.\n " additionalProperties: false properties: nationality: type: - string - 'null' description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 dateOfBirth: type: - string - 'null' description: "The date of birth of the infant.\n " format: date-time gender: description: "The gender of the passenger.\n " $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " $ref: '#/components/schemas/Name' declaredGender: type: - string - 'null' description: "The infant's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 travelDocuments: type: - array - 'null' description: "Travel Documents.\n " items: $ref: '#/components/schemas/PassengerTravelDocument' TravelNotificationCreateRequest: type: object description: "Create request for travel notifications.\n " additionalProperties: false properties: cultureCode: type: - string - 'null' description: "The culture code.\n " notificationDestination: description: "The notification destination.\n " $ref: '#/components/schemas/NotificationDestination' deviceName: type: - string - 'null' description: "The name of the device for the push notification.\n " events: type: - array - 'null' description: "The list of travel notification event.\n " items: $ref: '#/components/schemas/NotificationEventCreateRequest' timedEvents: type: - array - 'null' description: "The list of travel notification event.\n " items: $ref: '#/components/schemas/NotificationTimedEventCreateRequest' IJsonResponseOfIListOfNotificationEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/NotificationEvent' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerSeat: type: object description: "Model for a passenger seat for a segment.\n " additionalProperties: false properties: compartmentDesignator: type: - string - 'null' description: "The passenger seat compartment designator.\n " maxLength: 2 minLength: 0 penalty: type: integer description: "The passenger seat penalty.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 unitDesignator: type: - string - 'null' description: "The passenger seat unit designator.\n " seatInformation: description: "The passenger seat seat information.\n " $ref: '#/components/schemas/SeatInfo' arrivalStation: type: - string - 'null' description: "The leg arrival station.\n " maxLength: 3 minLength: 3 departureStation: type: - string - 'null' description: "The leg departure station.\n " maxLength: 3 minLength: 3 passengerKey: type: - string - 'null' description: "The passenger key associated with the seat.\n " unitKey: type: - string - 'null' description: "The seat's unique unit key.\n " crossReferenceSeatingPreference: type: - string - 'null' description: "The seating preference for non-hosted flight seating assignments.\nCould be either one of the following values:\nnull = seating preference is not applicable (usual value for hosted flights)\nN = no requested seating preference\nA = aisle\nW = window\nF = front seating location\nR = rear seating location\nAF = front seating location, on aisle\nAR = rear seating location, on aisle\nWF = front seating location, on window\nWR = rear seating location, on window\n " isPending: type: boolean description: "Determines whether or not the seat is pending request.\n " seatmapReference: type: - string - 'null' description: "The reference identifying what seat map the passenger seat is associated to.\n " IJsonResponseOfBaggageEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/BaggageEvent' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' UnitInventoryControlType: type: integer description: "Enum indicates the type of hold placed on the seat.\n \n\n0 = Session\n1 = None" x-enumNames: - Session - None enum: - 0 - 1 ChargeBreakdown: type: object description: "Defines a charge breakdown.\n " additionalProperties: false properties: total: type: - number - 'null' description: "The total amount.\n " format: decimal taxes: type: - number - 'null' description: "The total fee taxes amount.\n " format: decimal adjustments: type: - number - 'null' description: "The total adjusted amount.\n " format: decimal charges: type: - array - 'null' description: "The collection of charges within the calculation.\n " items: $ref: '#/components/schemas/ServiceCharge' SeatAssignmentMode: type: integer description: "Represents the seat assignment mode.\n \n\n0 = AutoDetermine\n1 = PreSeatAssignment\n2 = WebCheckIn" x-enumNames: - AutoDetermine - PreSeatAssignment - WebCheckIn enum: - 0 - 1 - 2 DeltaMapperOfPassengerAddressEditRequestv2: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 companyName: type: - string - 'null' description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 phone: type: - string - 'null' description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 emailAddress: type: - string - 'null' description: "The email address associated with the address.\n " cultureCode: type: - string - 'null' description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 refusedContact: type: - boolean - 'null' description: "Indicates if the passenger refused to enter a contact.\n " IJsonResponseOfIListOfPassengerAddress: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PassengerAddress' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' TravelNotificationEditRequest: type: object description: "Request base for travel notifications.\n " additionalProperties: false properties: cultureCode: type: - string - 'null' description: "The culture code.\n " notificationDestination: description: "The notification destination.\n " $ref: '#/components/schemas/NotificationDestination' deviceName: type: - string - 'null' description: "The name of the device for the push notification.\n " Gender: type: integer description: "Defines the different binary gender types.\n \n\n0 = XX\n1 = Male\n2 = Female" x-enumNames: - XX - Male - Female enum: - 0 - 1 - 2 FeeType: type: integer description: "Enumeration representing all the different fee types.\n \n\n0 = All\n1 = Tax\n2 = TravelFee\n3 = ServiceFee\n4 = PaymentFee\n5 = PenaltyFee\n6 = SsrFee\n7 = NonFlightServiceFee\n8 = UpgradeFee\n9 = SeatFee\n10 = BaseFare\n11 = SpoilageFee\n12 = NameChangeFee\n13 = ConvenienceFee\n14 = BaggageFee\n15 = FareSurcharge\n16 = PromotionDiscount\n17 = ServiceBundle\n18 = ExtraBagFee\n19 = ATPCOBagFee" x-enumNames: - All - Tax - TravelFee - ServiceFee - PaymentFee - PenaltyFee - SsrFee - NonFlightServiceFee - UpgradeFee - SeatFee - BaseFare - SpoilageFee - NameChangeFee - ConvenienceFee - BaggageFee - FareSurcharge - PromotionDiscount - ServiceBundle - ExtraBagFee - ATPCOBagFee enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 IJsonResponseOfPassenger: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Passenger' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfSsrPrice: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/SsrPrice' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' NotificationEventCreateRequest: type: object description: "A travel notification event create request.\n " additionalProperties: false required: - type properties: type: description: "The travel notification event type.\n " $ref: '#/components/schemas/NotificationEventType' Infant: type: object description: "Model representing an infant.\n " additionalProperties: false properties: dateOfBirth: type: - string - 'null' description: "The date of birth of the infant.\n " format: date-time gender: description: "The gender of the passenger.\n " $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " $ref: '#/components/schemas/Name' declaredGender: type: - string - 'null' description: "The infant's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 nationality: type: - string - 'null' description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 IJsonResponseOfVoucherInformation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/VoucherInformation' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' VoucherInformation: type: object description: "Voucher information. This model describes a voucher information after being queried by the voucher code.\n " additionalProperties: false properties: foreignCurrencyCode: type: - string - 'null' description: "The foreign currency code.\n " maxLength: 3 minLength: 0 foreignAmount: type: number description: "The amount of foreign currency.\n " format: decimal type: description: "The voucher type.\n " $ref: '#/components/schemas/VoucherType' password: type: - string - 'null' description: "The password for the voucher.\n " recordLocator: type: - string - 'null' description: "The record locator associated with the voucher.\n " maxLength: 12 minLength: 0 transactions: type: - array - 'null' description: "The voucher transactions.\n " items: $ref: '#/components/schemas/VoucherTransaction' voucherKey: type: - string - 'null' description: "The voucher key.\n " reference: type: - string - 'null' description: "The reference number for the voucher.\n " maxLength: 20 minLength: 0 configurationCode: type: - string - 'null' description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 status: description: "The voucher status.\n " $ref: '#/components/schemas/VoucherStatus' available: type: number description: "The availability count of the voucher.\n " format: decimal firstName: type: - string - 'null' description: "The first name associated with the voucher.\n " maxLength: 64 minLength: 0 lastName: type: - string - 'null' description: "The last name associated with the voucher.\n " maxLength: 64 minLength: 0 personKey: type: - string - 'null' description: "The person key associated with the voucher.\n " voucherIssuanceKey: type: - string - 'null' description: "The voucher issuance key.\n " expiration: type: - string - 'null' description: "The voucher expiration date.\n " format: date-time currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 amount: type: number description: "The amount of currency.\n " format: decimal calculatedAmount: type: number description: "The total amount of the booking that is payable by the voucher.\n " format: decimal customerNumber: type: - string - 'null' description: "The customer number associated to the voucher.\n " foreignCalculatedAmount: type: number description: "The total amount of the booking that is payable by the voucher,\nconverted to a foreign currency specified by the ForeignCalculatededCurrencyCode.\nUsed if the booking and voucher are in different currencies.\n " format: decimal foreignCalculatededCurrencyCode: type: - string - 'null' description: "The currency code for used with the ForeignCalculatedAmount field.\nUsed if the booking and voucher are in different currencies, this would be the currency code being converted to.\n " foreignReversableAmount: type: number description: "Returns the original available amount of the voucher, converted to a foreign currency.\nUsed if the booking and voucher are in different currencies.\n " format: decimal nameRestriction: description: "The name restriction for the voucher.\n " $ref: '#/components/schemas/VoucherNameRestriction' redeemableAmount: type: number description: "The total amount of the booking that the voucher can pay for up to the full amount of the voucher.\n " format: decimal reversableAmount: type: number description: "Returns the original available amount of the voucher.\n " format: decimal foreignAvailableCurrencyCode: type: - string - 'null' description: "The currency code for used with the ForeignAvailableAmount field.\nUsed if the booking and voucher are in different currencies, this\nwould be the currency code being converted to.\n " availableAmount: type: number description: "The total amount available on the voucher for use in the currency that the booking in state is in.\n " format: decimal Message: type: object description: "Defines a unique informational message.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The unique message code.\n " type: type: - string - 'null' description: "The message type.\n " value: type: - string - 'null' description: "The message's value.\n " status: description: "The message's status.\n " $ref: '#/components/schemas/MessageStatus' details: type: - object - 'null' description: "Dynamic detailed information about the message.\n " additionalProperties: type: string IJsonResponseOfPassengerDocumentCheckResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerDocumentCheckResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIDictionaryOfStringAndPassengerPriceBreakdown: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - object - 'null' description: "The payload data.\n " additionalProperties: $ref: '#/components/schemas/PassengerPriceBreakdown' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfBaggageGroupMembership: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/BaggageGroupMembership' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponse: type: object description: "Defines the JSON response contract for a not content type response.\n " additionalProperties: false properties: data: description: "The payload data, this will always be null for errors responses and no content responses.\n " errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerKeyResponse: type: object description: "Model representing passenger's old and new key in the event of a key change.\n " additionalProperties: false properties: oldPassengerKey: type: - string - 'null' description: "The old passenger key.\n " newPassengerKey: type: - string - 'null' description: "The new passenger key.\n " IJsonResponseOfNotificationTimedEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/NotificationTimedEvent' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfTravelNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/TravelNotification' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' DeliveryMethodCode: type: integer description: "Represents the delivery method codes.\n \n\n0 = Email\n1 = Sms\n2 = Push" x-enumNames: - Email - Sms - Push enum: - 0 - 1 - 2 PassengerFee: type: object description: "Model representing passenger fee information.\n " additionalProperties: false required: - code properties: isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: - string - 'null' description: "The fee detail.\n " maxLength: 32 minLength: 0 passengerFeeKey: type: - string - 'null' description: "The passenger fee key.\n " override: type: boolean description: "The fee override.\n " flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 note: type: - string - 'null' description: "The fee notes.\n " maxLength: 128 minLength: 0 createdDate: type: - string - 'null' description: "The created date for the fee.\n " format: date-time isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: - array - 'null' description: "The list of service charges for the fee.\n " items: $ref: '#/components/schemas/ServiceCharge' type: description: "The fee type.\n " $ref: '#/components/schemas/FeeType' ssrCode: type: - string - 'null' description: "The SSR code.\n " ssrNumber: type: integer description: "The fee SSR number.\n " paymentNumber: type: integer description: "The fee payment number.\n " VoucherNameRestriction: type: integer description: "Defines how the name on the voucher will be validated.\n \n\n0 = None\n1 = MustBePassenger\n2 = MustBePassengerOrContact" x-enumNames: - None - MustBePassenger - MustBePassengerOrContact enum: - 0 - 1 - 2 IJsonResponseOfPassengerBag: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerBag' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' VoucherTransaction: type: object description: "The voucher transaction model.\n " additionalProperties: false properties: foreignCurrencyCode: type: - string - 'null' description: "The foreign currency code.\n " maxLength: 3 minLength: 0 foreignAmount: type: number description: "The amount of foreign currency.\n " format: decimal currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 amount: type: number description: "The amount of currency.\n " format: decimal voucherTransactionKey: type: - string - 'null' description: "The voucher transaction key.\n " type: description: "The voucher transaction type.\n " $ref: '#/components/schemas/VoucherTransactionType' recordLocator: type: - string - 'null' description: "The record locator associated with the voucher transaction.\n " IJsonResponseOfPassengerKeyResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerKeyResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerPriceBreakdown: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerPriceBreakdown' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' VoucherTransactionType: type: integer description: "Defines voucher transaction type.\n \n\n0 = Debit\n1 = Credit\n2 = Void\n3 = Reinstate\n4 = Adjustment\n5 = ExpirationDateChange\n6 = VoucherTypeChange\n7 = VoucherOwnerChange" x-enumNames: - Debit - Credit - Void - Reinstate - Adjustment - ExpirationDateChange - VoucherTypeChange - VoucherOwnerChange enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 Exception: type: object additionalProperties: false properties: Message: type: string InnerException: $ref: '#/components/schemas/Exception' Source: type: - string - 'null' StackTrace: type: - string - 'null' PassengerInformation: type: object description: "Represents additional passenger information.\n " additionalProperties: false properties: nationality: type: - string - 'null' description: "The passenger's nationality.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The resident country.\n " maxLength: 2 minLength: 2 gender: description: "The passenger's binary gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The passenger's date of birth.\n " format: date-time familyNumber: type: - integer - 'null' description: "The unique identifier of a family registered in the system.\n " declaredGender: type: - string - 'null' description: "The passenger's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 PassengerTravelDocument: type: object description: "Model representing a passenger travel document.\n " additionalProperties: false required: - documentTypeCode properties: documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: - string - 'null' description: "The issuer code for the travel document (country code).\n " maxLength: 3 minLength: 0 birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " $ref: '#/components/schemas/Name' nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: - string - 'null' description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ passengerTravelDocumentKey: type: - string - 'null' description: "A key that uniquely identifies a travel document in the context of a specific passenger.\n " WeightCategory: type: integer description: "Defines the categories of adults by gender or specifies the passenger as a child. This is used for balance\ndeterminations.\n \n\n0 = Undefined\n1 = Male\n2 = Female\n3 = Child" x-enumNames: - Undefined - Male - Female - Child enum: - 0 - 1 - 2 - 3 SeatInfo: type: object description: "The model for the seat information such as deck, seat properties, etc.\n " additionalProperties: false properties: deck: type: integer description: "Gets or sets the deck.\n " seatSet: type: integer description: "Gets or sets the seat set.\n " propertyList: type: - object - 'null' description: "The property list by type code and value.\n " additionalProperties: type: string TravelComponent: type: integer description: "Enumeration for a travel component type.\n \n\n0 = Unknown\n1 = Itinerary\n2 = Trip\n3 = Journey\n4 = Segment\n5 = Leg\n6 = SpecificLeg\n9 = ItineraryWithJourneySalesDate\n10 = TripWithJourneySalesDate\n11 = JourneyWithBookingSalesDate\n12 = JourneyWithJourneySalesDate\n13 = SegmentWithJourneySalesDate\n14 = LegWithJourneySalesDate\n15 = Fare\n16 = LegWithConfirmingSalesDate\n17 = SegmentWithConfirmingSalesDate\n18 = JourneyWithConfirmingSalesDate" x-enumNames: - Unknown - Itinerary - Trip - Journey - Segment - Leg - SpecificLeg - ItineraryWithJourneySalesDate - TripWithJourneySalesDate - JourneyWithBookingSalesDate - JourneyWithJourneySalesDate - SegmentWithJourneySalesDate - LegWithJourneySalesDate - Fare - LegWithConfirmingSalesDate - SegmentWithConfirmingSalesDate - JourneyWithConfirmingSalesDate enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 TravelDocumentEditRequest: type: object description: "Defines the edit travel document request.\n " additionalProperties: false properties: birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " $ref: '#/components/schemas/Name' nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: - string - 'null' description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ TravelNotification: type: object description: "A travel notification.\n " additionalProperties: false properties: travelNotificationKey: type: - string - 'null' description: "The travel notification key.\n " events: type: - array - 'null' description: "The list of travel notification event.\n " items: $ref: '#/components/schemas/NotificationEvent' timedEvents: type: - array - 'null' description: "The list of travel notification event.\n " items: $ref: '#/components/schemas/NotificationTimedEvent' cultureCode: type: - string - 'null' description: "The culture code.\n " notificationDestination: description: "The notification destination.\n " $ref: '#/components/schemas/NotificationDestination' deviceName: type: - string - 'null' description: "The name of the device for the push notification.\n " expirationDate: type: - string - 'null' description: "The expiration date.\n " format: date-time createdDate: type: - string - 'null' description: "The created date of the travel notification.\n " format: date-time DeltaMapperOfTravelNotificationEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: cultureCode: type: - string - 'null' description: "The culture code.\n " notificationDestination: description: "The notification destination.\n " properties: deliveryMethodCode: description: "The delivery method code.\n " $ref: '#/components/schemas/DeliveryMethodCode' destination: type: - string - 'null' description: "The notification destination, an email or phone number.\n " deviceName: type: - string - 'null' description: "The name of the device for the push notification.\n " IJsonResponseOfGetOverrideFeeQuoteResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/GetOverrideFeeQuoteResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' Name: type: object description: "Defines a common name.\n " additionalProperties: false properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 ApisAddressStatus: type: integer description: "Defines what type of APIS requirement is the address.\n \n\n0 = Residence\n1 = InCountry\n2 = Emergency\n3 = Contact" x-enumNames: - Residence - InCountry - Emergency - Contact enum: - 0 - 1 - 2 - 3 PassengerBag: type: object description: "Model information about the passenger's baggage.\n " additionalProperties: false properties: identifier: type: - string - 'null' description: "The unique transportation identifier.\n " maxLength: 4 minLength: 1 nonStandard: type: boolean description: "Flag for marking a bag as a non-standard piece of luggage.\n " osTag: type: - string - 'null' description: "The OSTag in Bag object.\n " maxLength: 32 minLength: 0 taggedToStation: type: - string - 'null' description: "The tagged to station in the bag object. This is the last station where\nthe bag is going to. For example, on a trip from SLC to JFK, JFK would\nbe the tagged to station value.\n " maxLength: 3 minLength: 3 weight: type: integer description: "The Weight in Bag object.\n " maximum: 32767.0 minimum: 0.0 weightType: description: "The WeightType in Bag object.\n " $ref: '#/components/schemas/WeightType' baggageKey: type: - string - 'null' description: "Unique key for the baggage.\n " type: type: - string - 'null' description: "The type of baggage.\n " maxLength: 6 minLength: 0 osTagDate: type: - string - 'null' description: "The bag OS tag date.\n " format: date-time stationCode: type: - string - 'null' description: "The bag station code.\n " maxLength: 3 minLength: 3 taggedToCarrierCode: type: - string - 'null' description: "The bag tagged to carrier code.\n " maxLength: 3 minLength: 2 IJsonResponseOfPassengerSeat: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerSeat' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerAddress: type: object description: "Passenger address information. This contains more data then the base address class.\n " additionalProperties: false properties: status: description: "The addresses APIS status.\n " $ref: '#/components/schemas/ApisAddressStatus' companyName: type: - string - 'null' description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 phone: type: - string - 'null' description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 stationCode: type: - string - 'null' description: "Station code associated with this address.\n " maxLength: 3 minLength: 3 emailAddress: type: - string - 'null' description: "The email address associated with the address.\n " cultureCode: type: - string - 'null' description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 refusedContact: type: - boolean - 'null' description: "Indicates if the passenger refused to enter a contact.\n " lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 passengerAddressKey: type: - string - 'null' description: "The unique address identifier.\n " VoucherType: type: integer description: "Defines the type of voucher.\n \n\n0 = Credit\n1 = SingleUseCredit\n2 = Service\n3 = SingleUse\n4 = MultiUse\n5 = SingleUseNegativeAdjustment\n6 = PassengerSelect" x-enumNames: - Credit - SingleUseCredit - Service - SingleUse - MultiUse - SingleUseNegativeAdjustment - PassengerSelect enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 InfantFee: type: object description: "Defines the infant fee information.\n " additionalProperties: false required: - code properties: isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: - string - 'null' description: "The fee detail.\n " maxLength: 32 minLength: 0 passengerFeeKey: type: - string - 'null' description: "The passenger fee key.\n " override: type: boolean description: "The fee override.\n " flightReference: type: - string - 'null' description: "The flight reference which signifies a link to a segment and or leg.\n " maxLength: 22 minLength: 0 note: type: - string - 'null' description: "The fee notes.\n " maxLength: 128 minLength: 0 createdDate: type: - string - 'null' description: "The created date for the fee.\n " format: date-time isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: - array - 'null' description: "The list of service charges for the fee.\n " items: $ref: '#/components/schemas/ServiceCharge' PassengerSsrPriceRequest: type: object description: "The multi-Ssr price request model for a single passenger.\n " additionalProperties: false required: - ssrCodes properties: ssrCodes: type: array description: "The ssr codes. These can be found under the /resources/ssrs GET endpoint.\n " maxItems: 20 items: type: string collectedCurrencyCode: type: - string - 'null' description: "The collected currency code. These can be found under the /resources/currencies GET endpoint.\n " maxLength: 3 minLength: 0 DeltaMapperOfTravelDocumentEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: - string - 'null' description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ WeightType: type: integer description: "Weight Type enumeration.\n \n\n0 = Default\n1 = Pounds\n2 = Kilograms" x-enumNames: - Default - Pounds - Kilograms enum: - 0 - 1 - 2 IJsonResponseOfPassengerAddress: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerAddress' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerInfant: type: object description: "Model representing an infant with a passenger.\n " additionalProperties: false properties: nationality: type: - string - 'null' description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 dateOfBirth: type: - string - 'null' description: "The date of birth of the infant.\n " format: date-time gender: description: "The gender of the passenger.\n " $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " $ref: '#/components/schemas/Name' declaredGender: type: - string - 'null' description: "The infant's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 fees: type: - array - 'null' description: "The collection of infant fees.\n " items: $ref: '#/components/schemas/InfantFee' travelDocuments: type: - array - 'null' description: "Travel Documents.\n " items: $ref: '#/components/schemas/PassengerTravelDocument' type: type: - string - 'null' description: "The infant passenger type.\n " TravelDocumentCreateRequest: type: object description: "Defines a create travel documents request.\n " additionalProperties: false required: - documentTypeCode properties: birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " $ref: '#/components/schemas/Name' nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: - string - 'null' description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: - string - 'null' description: "The issuer code for the travel document (country code).\n " maxLength: 3 minLength: 0 PassengerBase: type: object description: "Defines the base passenger details.\n " additionalProperties: false properties: customerNumber: type: - string - 'null' description: "The passenger customer number.\n " maxLength: 20 minLength: 0 name: description: "The passenger's name.\n " $ref: '#/components/schemas/Name' discountCode: type: - string - 'null' description: "The discount code associated with the passenger type.\n " maxLength: 8 minLength: 0 program: description: "The passenger programs.\n " $ref: '#/components/schemas/PassengerProgram' info: description: "Additional passenger information.\n " $ref: '#/components/schemas/PassengerInformation' SeatFeeQuoteRequest: type: object description: "Represents a seat fee quote request.\n " additionalProperties: false required: - seatPreference properties: seatPreference: description: "The seat preference.\n " $ref: '#/components/schemas/SeatPreference' inventoryControlType: description: "The type of hold placed on seats.\n " $ref: '#/components/schemas/UnitInventoryControlType' ignoreSeatSSRs: type: - boolean - 'null' description: "Determines whether or not SSRs associated with the seat will be ignored when determining\nunit availability.\n " seatAssignmentMode: description: "The seat assignment mode can affect available units in seat maps and whether or not\nseat fees are charged based on channel type, role settings, customer programs\nand/or class of service.\n " $ref: '#/components/schemas/SeatAssignmentMode' monetaryOnly: type: - boolean - 'null' description: "Indicates whether the fee to be priced is to be priced in money or points.\n " collectedCurrencyCode: type: - string - 'null' description: "Optional currency code. If different than the booking currency code,\nfees in that currency will be returned if the conversion exists in new skies utilities\n " maxLength: 3 minLength: 0 OptionalServiceInformation: type: object description: "Represents the optional service information model.\n " additionalProperties: false properties: carrierCode: type: - string - 'null' description: "The optional service carrier code.\n " maxLength: 3 minLength: 0 reasonForIssuanceSubCode: type: - string - 'null' description: "The optional service reason for issuance sub-code (RFISC).\n " maxLength: 3 minLength: 0 IJsonResponseOfIListOfPassengerEmdCoupon: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PassengerEmdCoupon' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' MessageStatus: type: integer description: "Defines the message status.\n \n\n0 = General\n1 = Warning\n2 = Critical" x-enumNames: - General - Warning - Critical enum: - 0 - 1 - 2 EmdCouponStatus: type: integer description: "Represents the EMD coupon status options.\n \n\n0 = Unknown\n1 = HeldConfirmed\n2 = HoldingNeed\n3 = HoldingConfirmedEmdRequired\n4 = HoldingConfirmedEmdIssued" x-enumNames: - Unknown - HeldConfirmed - HoldingNeed - HoldingConfirmedEmdRequired - HoldingConfirmedEmdIssued enum: - 0 - 1 - 2 - 3 - 4 NotificationDestination: type: object description: "A travel notification destination.\n " additionalProperties: false required: - deliveryMethodCode properties: deliveryMethodCode: description: "The delivery method code.\n " $ref: '#/components/schemas/DeliveryMethodCode' destination: type: - string - 'null' description: "The notification destination, an email or phone number.\n " NotificationEvent: type: object description: "A travel notification event.\n " additionalProperties: false required: - type properties: type: description: "The travel notification event type.\n " $ref: '#/components/schemas/NotificationEventType' createdDate: type: - string - 'null' description: "The created date of the travel notification.\n " format: date-time NotificationEventType: type: integer description: "Represents the type of notification event type for a travel notification event.\n \n\n0 = DepartureDelay\n1 = ArrivalDelay\n2 = ScheduleChange\n3 = CheckIn\n4 = GateInformation" x-enumNames: - DepartureDelay - ArrivalDelay - ScheduleChange - CheckIn - GateInformation enum: - 0 - 1 - 2 - 3 - 4 DeltaMapperOfPassengerBase: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: customerNumber: type: - string - 'null' description: "The passenger customer number.\n " maxLength: 20 minLength: 0 name: description: "The passenger's name.\n " properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 discountCode: type: - string - 'null' description: "The discount code associated with the passenger type.\n " maxLength: 8 minLength: 0 program: description: "The passenger programs.\n " properties: code: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ levelCode: type: - string - 'null' description: "The program level code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ number: type: - string - 'null' description: "The program number.\n " maxLength: 32 minLength: 0 info: description: "Additional passenger information.\n " properties: nationality: type: - string - 'null' description: "The passenger's nationality.\n " maxLength: 2 minLength: 0 residentCountry: type: - string - 'null' description: "The resident country.\n " maxLength: 2 minLength: 2 gender: description: "The passenger's binary gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The passenger's date of birth.\n " format: date-time familyNumber: type: - integer - 'null' description: "The unique identifier of a family registered in the system.\n " declaredGender: type: - string - 'null' description: "The passenger's declared gender. A value of \"F\" is mapped to a female binary gender. All other values will be\nmapped to a male binary gender.\n " maxLength: 2 minLength: 0 IJsonResponseOfPassengerFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerFee' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfBaggageEventResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/BaggageEventResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIDictionaryOfStringAndIListOfPassengerSsrPrice: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - object - 'null' description: "The payload data.\n " additionalProperties: type: array items: $ref: '#/components/schemas/PassengerSsrPrice' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerTypePriceBreakdown: type: object description: "Defines the unique passenger type level pricing breakdown.\n " additionalProperties: false properties: services: description: "The charge breakdown of the service fees.\n " $ref: '#/components/schemas/ChargeBreakdown' specialServices: description: "The charge breakdown of the special service requests.\n " $ref: '#/components/schemas/ChargeBreakdown' seats: description: "The charge breakdown of seat fees.\n " $ref: '#/components/schemas/ChargeBreakdown' upgrades: description: "The charge breakdown of upgrade fees.\n " $ref: '#/components/schemas/ChargeBreakdown' spoilage: description: "The charge breakdown of spoilage fees.\n " $ref: '#/components/schemas/ChargeBreakdown' nameChanges: description: "The charge breakdown of name change fees.\n " $ref: '#/components/schemas/ChargeBreakdown' convenience: description: "The charge breakdown of convenience fees.\n " $ref: '#/components/schemas/ChargeBreakdown' infant: description: "The charge breakdown of infant fees.\n " $ref: '#/components/schemas/ChargeBreakdown' totalCost: type: - number - 'null' description: "The total cost for the passenger.\nThese values are only populated by NewSkies after a booking commit\n " format: decimal passengerTypeCode: type: - string - 'null' description: "The passenger type code.\n " ServiceCharge: type: object description: "Model that represents the fare service charge information.\n " additionalProperties: false properties: amount: type: number description: "The service charge amount.\n " format: decimal code: type: - string - 'null' description: "The service charge code.\n " detail: type: - string - 'null' description: "The service charge detail.\n " maxLength: 10 minLength: 0 type: description: "The service charge type.\n " $ref: '#/components/schemas/ChargeType' collectType: description: "The service charge collect type.\n " $ref: '#/components/schemas/CollectType' currencyCode: type: - string - 'null' description: "The service charge currency code.\n " maxLength: 3 minLength: 0 foreignCurrencyCode: type: - string - 'null' description: "The service charge foreign currency code.\n " maxLength: 3 minLength: 0 foreignAmount: type: number description: "The service charge foreign amount.\n " format: decimal ticketCode: type: - string - 'null' description: "The service charge ticket code.\n " maxLength: 3 minLength: 0 NotificationTimedEvent: type: object description: "A travel notification timed event.\n " additionalProperties: false required: - type properties: type: description: "The travel notification timed event type.\n " $ref: '#/components/schemas/NotificationTimedEventType' minutesToEvent: type: integer description: "The minutes to the event.\n " format: int32 createdDate: type: - string - 'null' description: "The created date of the travel notification.\n " format: date-time BaggageEventCreateRequest: type: object description: "Represents the request to create baggage events.\n " additionalProperties: false required: - baggageEventCode - locationCode - toLocationCode properties: baggageEventCode: type: string description: "Baggage event code.\n " minLength: 1 eventText: type: - string - 'null' description: "Event text.\n " locationCode: type: string description: "Baggage event location code.\n " minLength: 1 toLocationCode: type: string description: "Destination location code to which the baggage event pertains.\n " minLength: 1 ErrorResponse: type: object description: "Defines a unique error response.\n " additionalProperties: false properties: exception: description: "The original exception that was thrown and all the exception details.\n " $ref: '#/components/schemas/Exception' rawMessage: type: - string - 'null' description: "The original raw message set (non-localized).\n " code: type: - string - 'null' description: "The unique error code. The primary value used to match against a unique message localized for the end user in the\nchosen language.\n " message: type: - string - 'null' description: "The error message. Deprecated: Please use the Code instead.\n " type: type: - string - 'null' description: "The error type showing severity. Values: Critical, Error, Validation, Information.\n " number: type: - integer - 'null' description: "A unique identifier in numeric form. This is required for Splunk logging. If none is provided a number will be\ngenerated based on code and type.\n " format: int32 maximum: 99999.0 minimum: 0.0 details: type: - object - 'null' description: "Dynamic detailed information about the error.\n " additionalProperties: type: string ActivityId: type: - string - 'null' description: "The activity ID unique to the request. Useful for debugging purposes to uniquely look up what happened for this\nspecific request.\n " FeePricingMode: type: integer description: "The fee pricing mode enumeration.\n \n\n0 = MonetaryOnly\n1 = PointsOnly" x-enumNames: - MonetaryOnly - PointsOnly enum: - 0 - 1 IJsonResponseOfIDictionaryOfStringAndPassengerTypePriceBreakdown: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - object - 'null' description: "The payload data.\n " additionalProperties: $ref: '#/components/schemas/PassengerTypePriceBreakdown' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfTravelNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/TravelNotification' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPassengerSeat: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PassengerSeat' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfNotificationTimedEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/NotificationTimedEvent' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PassengerAddressEditRequestv2: type: object description: "Defines a passenger address edit request v2.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 companyName: type: - string - 'null' description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 phone: type: - string - 'null' description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 emailAddress: type: - string - 'null' description: "The email address associated with the address.\n " cultureCode: type: - string - 'null' description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 refusedContact: type: - boolean - 'null' description: "Indicates if the passenger refused to enter a contact.\n " BaggageEvent: type: object description: "Represents a baggage event.\n " additionalProperties: false properties: baggageEventKey: type: - string - 'null' description: "Baggage event key.\n " baggageKey: type: - string - 'null' description: "Baggage key.\n " createdDate: type: string description: "Created date.\n " format: date-time baggageEventCode: type: - string - 'null' description: "Baggage event code.\n " eventText: type: - string - 'null' description: "Event text.\n " locationCode: type: - string - 'null' description: "Baggage event location code.\n " toLocationCode: type: - string - 'null' description: "Destination location code to which the baggage event pertains.\n " PassengerDocumentCheckResponse: type: object description: "Model for passenger document check response.\n " additionalProperties: false properties: passengerAlternateKey: type: - string - 'null' description: "The passenger alternative key.\n " name: description: "The passenger name.\n " $ref: '#/components/schemas/Name' documentCheckStatus: description: "The document check status of the passenger.\n " $ref: '#/components/schemas/DocumentCheckStatus' IJsonResponseOfIListOfPassengerBag: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PassengerBag' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' SeatPreferenceStatus: type: integer description: "Defines the seat preference status.\n \n\n0 = Unknown\n1 = Met\n2 = NotMet" x-enumNames: - Unknown - Met - NotMet enum: - 0 - 1 - 2 BaggageGroupMembership: type: object description: "The baggage group membership for a booking\n " additionalProperties: false properties: baggageGroupNumber: type: integer description: "Group number that will be assigned to bags added to the passengers PassengerKeys on the segments SegmentKeys.\n " format: int32 passengerKeys: type: - array - 'null' description: "The unique passenger key which will allow you to align group number to the segment from the GET /booking method.\n " items: type: string segmentKeys: type: - array - 'null' description: "The unique segment key which will allow you to align group number to the segment from the GET /booking method.\n " items: type: string securitySchemes: JWT: type: http description: Paste your JWT token from the token endpoint. scheme: bearer bearerFormat: jwt x-generator: NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))