openapi: 3.2.0 info: title: Tui Group Settings API version: '1.0' description: 'Operations tagged settings across 2 of this provider''s published API definitions: tui-group-tui-newskies-digital-api-openapi.yml, tui-group-tui-newskies-gonow-api-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground - url: https://prod.api.tui/flight/newskies/gonow description: TUI Prod - url: https://playground.api.tui/flight/newskies/gonow description: TUI Playground security: - JWT: [] tags: - name: settings paths: /api/nsk/v1/settings/booking: get: tags: - settings summary: Get the general settings. description: 'GraphQL endpoint: settingsBookingGeneral' operationId: nsk_v1_settings_booking_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: Authentication is required for this request. 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' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' 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 '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGeneralSettings' examples: Retrieve General Settings: description: Example response for successfully retrieving the booking general settings value: data: allowChangeSsrOnCheckedInPassenger: true allowBlockedSeatAssignment: false allowChangeOnRestrictedFlight: false allowPromoCodes: true allowEditableApiChannel: true allowEditableDirectChannel: true allowEditableGdsBookingWithTaPayment: true allowEditableGdsChannel: true allowEditableWebChannel: true allowGroupNameUpdates: true allowManifestRetrievalOnUnblockedFlightLines: true allowOverbookingSsrOnMove: false allowQueueingGdsBookingWithTaFopForETicketReissue: false allowRestrictedSeatAssignment: false allowSeatAssignment: 2 bookingAccessControl: 7 viewBookingsByControl: 3 editBookingsByControl: 3 defaultBookingComment: null doNotIncludeUnitProperties: true duplicateBookingDetectionTimeSpan: 00:00:00 enableAutomaticSeatAssignment: true highlightFareOverride: 0 highlightIrop: 0 highlightScheduleChange: 0 highlightStandby: 0 highlightUpgrade: 0 managePassiveSegments: true maskHistory: true reassignSeatingBehavior: 0 restrictedExternalSystemCodes: [] timeDisplay: 0 allowSeatGroupRestrictionOverride: true allowAccessToComments: true sharedCommentTypes: reservation: true itinerary: true manifest: true alert: true allowOverrideOfSalesChannel: true autoFillContactInformationByPhoneNumber: false allowAccessToArchivedBooking: true allowQueueBookingsOnSpecifiedLeg: false queueFlightOpenTimeSpan: 00:00:00 queueFlightCloseTimeSpan: 00:00:00 allowReleaseHeldSessionSeat: false servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/booking/checkin: get: tags: - settings summary: Get the checkin settings. description: 'GraphQL endpoint: settingsBookingCheckIn' operationId: nsk_v1_settings_booking_checkin_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckInSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/booking/contact: get: tags: - settings summary: Get the contact settings. description: 'GraphQL endpoint: settingsBookingContactv2' operationId: nsk_v1_settings_booking_contact_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfContactSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/booking/customerAccount: get: tags: - settings summary: Gets the role-based customer account settings. description: 'GraphQL endpoint: settingsBookingCustomerAccountv2' operationId: nsk_v1_settings_booking_customerAccount_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. 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' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' 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 '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerAccountSettings' examples: Retrieve Customer Account Settings: description: Example response for successfully retrieving the booking customer account settings value: data: allowCustomerMerge: true allowCustomerProgram: true allowSeatLocationOption: true customerAccessControl: 1 defaultCustomerNotificationPreference: 0 defaultSeatPreference: 0 disableCustomerAddress: 0 disableCustomerCurrency: 1 disableCustomerDateOfBirth: 0 disableCustomerEmail: 1 disableCustomerFax: 1 disableCustomerLanguage: 1 disableCustomerNationality: 1 disableCustomerNotificationPreference: 1 disableCustomerPayment: 0 disableCustomerPhone: 1 disableCustomerResidentCountry: 1 disableCustomerTitle: 1 disableCustomerType: 0 allowAgentToModifyProgramLevel: true maskCustomerName: true maskCustomerSuffix: true maskTravelDocumentDetails: true maskCustomerWebUserId: true maskCustomerGender: true maskAffiliation: true servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/booking/fee: get: tags: - settings summary: Get the fee settings. description: 'GraphQL endpoint: settingsBookingFee' operationId: nsk_v1_settings_booking_fee_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFeeSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/booking/flightSearch: get: tags: - settings summary: Get the flight search settings. description: 'GraphQL endpoint: settingsBookingFlightSearch' operationId: nsk_v1_settings_booking_flightSearch_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFlightSearchSettings' post: tags: - settings summary: Create the flight search settings. description: 'GraphQL endpoint: settingsBookingFlightSearchAdd' operationId: nsk_v1_settings_booking_flightSearch_post requestBody: x-name: query description: The role code query. content: application/json: schema: $ref: '#/components/schemas/RoleCodeQuery' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - settings summary: Edit the role based flight search settings. description: 'GraphQL endpoint: settingsBookingFlightSearchSet' operationId: nsk_v1_settings_booking_flightSearch_put parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 1 requestBody: x-name: request description: The flight search settings request. content: application/json: schema: $ref: '#/components/schemas/FlightSearchSettings' required: true x-position: 2 responses: '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - settings summary: Patches the role based flight search settings. description: 'GraphQL endpoint: settingsBookingFlightSearchModify' operationId: nsk_v1_settings_booking_flightSearch_patch parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 1 requestBody: x-name: request description: The flight search settings request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfFlightSearchSettings' required: true x-position: 2 responses: '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/booking/general: get: tags: - settings summary: Gets the non-role based general booking settings. description: 'GraphQL endpoint: generalBookingSettings' operationId: nsk_v1_settings_booking_general_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGeneralBookingSettings' examples: Retrieve General Booking Settings Response: description: Example response for successfully retrieving the general booking settings. value: data: maximumAgeForInfantInLap: 24 useDirectCurrencyConversion: true clearInfantDetailsWhenInfantInLapIsDeleted: true mixedClassRouteFaresEnabled: true sumOfSectorFaresEnabled: true sumOfSectorProductClassPreCompression: true sellSeatSsrBeforeAssignment: true applyAllUpPricingGlobally: true repriceWhenCustomerProgramIsChanged: true recalculateHoldWithBookingChanges: true preventCommitBookingWithCancelledInventory: true defaultCarrierCode: NV defaultBookingSubQueueCode: Unknwn maximumNumberOfMarkets: 6 interlineHoldBeforeDeparture: 2880 warningTimeBeforeHoldCancel: 0 interlineConnectionPartners: G3 applyFareForInLapInfantWithPassengerType: ' ' validateMaximumAgeBy: FirstSegment validateMinimumAgeBy: FirstSegment indiaGstRegistrationContactType: None enforceStandardGroupBooking: true storeConfirmingWaivedFees: true personallyIdentifiableInformationMasking: true lowFareCacheMode: null retrieveFareInformationFromGeneralReferenceManagement: true enableGenderNeutral: true storeDeletedManuallyAddedFees: true invalidNameCharacters: '@' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/booking/passenger: get: tags: - settings summary: Get the passenger settings. description: 'GraphQL endpoint: settingsBookingPassenger' operationId: nsk_v1_settings_booking_passenger_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSettings' post: tags: - settings summary: Create the passenger info settings. description: 'GraphQL endpoint: settingsBookingPassengerAdd' operationId: nsk_v1_settings_booking_passenger_post requestBody: x-name: query description: The role code query. content: application/json: schema: $ref: '#/components/schemas/RoleCodeQuery' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - settings summary: Edit the role based passenger info settings. description: 'GraphQL endpoint: settingsBookingPassengerSet' operationId: nsk_v1_settings_booking_passenger_put parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 1 requestBody: x-name: request description: The passenger settings request. content: application/json: schema: $ref: '#/components/schemas/PassengerSettings' required: true x-position: 2 responses: '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - settings summary: Patches the role based passenger info settings. description: 'GraphQL endpoint: settingsBookingPassengerModify' operationId: nsk_v1_settings_booking_passenger_patch parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 1 requestBody: x-name: request description: The passenger settings request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPassengerSettings' required: true x-position: 2 responses: '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/settings/booking/payment: get: tags: - settings summary: Get the role based booking payment settings. description: 'GraphQL endpoint: settingsBookingPaymentv2' operationId: nsk_v2_settings_booking_payment_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. 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' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' 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 '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingPaymentSettingsv2' examples: Retrieve Booking Payment Settings v2: description: Example response for successfully retrieving the booking payment settings v2 value: data: allowExternalPaymentChargeBack: true allowHoldDateOverride: true allowIgnoreVoucherRestrictions: true allowVoucherIssuance: true allowManualAuthorization: true allowOverPay: true allowUnderPay: true allowUnvoidVoucher: true allowUseOfBinFraudTool: true allowVoidVoucher: true enableAutoPaymentVerification: true allowConfirmBookingWithPartialTicketing: true allowUnmaskingCreditCardNumber: true allowDisplayNoPaymentWarning: true requirePassengerOrContactForCreditFile: true requirePassengerOrContactForCreditShell: true requireCommentsForCreditShell: true disableAlternateAgAccount: true creditShellCreditCode: BKGI30 maxInstallmentOverride: 1 maxPaymentQueries: 1 secondsTillStartPaymentQuery: 1 secondsTillRepeatPaymentQuery: 1 holdsDaysBeforeDeparture: 10.00:00:00 holdsDaysAfterDeparture: -00:01:00 allowPendingCustomerActionAuthorization: true allowManualAuthorizationOfPendingPaymentWithoutValidation: false maskPaymentFields: true allowManualAuthorizationOfPaymentStatuses: - 3 - 2 - 6 - 4 displayVoucherNumber: true allowOverPayWithVoucherPayment: true allowVoucherOwnerUpdate: true post: tags: - settings summary: BETA - Create the booking payment settings based on the parent role code. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. See /api/nsk/v1/resources/roles/{roleCode}/settings to verify if settings have been configured for this role. Even without unique settings being configured for a role the GET call will always return data due to it returning the effective permissions of the role. This can potentially be based on the parent roles. GraphQL endpoint: settingsBookingPaymentAdd' operationId: nsk_v2_settings_booking_payment_post parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - settings summary: BETA - Edit the role based booking payment settings. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. GraphQL endpoint: settingsBookingPaymentSet' operationId: nsk_v2_settings_booking_payment_put parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 1 requestBody: x-name: request description: The new booking payment settings. content: application/json: schema: $ref: '#/components/schemas/BookingPaymentSettingsv2' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/BookingPaymentSettingsv2' patch: tags: - settings summary: BETA - Partially edit the role based booking payment settings. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. GraphQL endpoint: settingsBookingPaymentModify' operationId: nsk_v2_settings_booking_payment_patch parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 1 requestBody: x-name: request description: The new booking payment settings. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfBookingPaymentSettingsv2' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/BookingPaymentSettingsv2' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/booking/paymentCodes: get: tags: - settings summary: Gets the role-based booking payment codes settings. description: 'GraphQL endpoint: settingsBookingPaymentCodes' operationId: nsk_v1_settings_booking_paymentCodes_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingPaymentCodesSettings' examples: Booking Payment Codes Settings: description: Example response for successfully retrieving the booking payment codes settings. value: data: voucherConfigurationCodes: - VOUCH1 - XVOUCH - VOUCHR servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/booking/reserveFlights: get: tags: - settings summary: Get the reserve flight settings. description: 'GraphQL endpoint: settingsReserveFlights' operationId: nsk_v1_settings_booking_reserveFlights_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. 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' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' 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 '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfReserveFlightsSettings' examples: Retrieve Booking Reserve Flights Settings: description: Example response for successfully retrieving the booking reserve flights settings value: data: availabilityDepartureTimeLimit: -41.15:00:00 availabilityMaxDaysOut: 60.00:00:00 sellDepartureTimeLimit: -416.15:00:00 availableSpaceDisplayMax: 0 flightTimeChangeToleranceMinutes: 0 viewCapacity: false viewLidSold: false viewSsrAvailability: true viewManifestControl: 2 adHocFlightControl: 0 allowSellOverbook: 0 allowMoveOverbook: 0 allowUpgradeOverbook: 0 allowSplitJourneyMoves: false allowMove: 2 moveByMaximumClassAvailability: true requireSameCityPairOnMoves: false maxMoveDaysForward: 365.00:00:00 maxMoveDaysBack: 365.00:00:00 daysBeforeIrop: 365.00:00:00 allowFareOverride: true allowClosedFlightFareOverride: true allowFareOverrideDuringDivide: true allowIgnoreRestrictions: true allowInvalidPriceStatus: true cancelDepartureTimeLimit: -1000.00:00:00 seatAssignmentTimeLimit: -05:00:00 allowUpgrade: false allowCreateAdhocConnect: true minimumTimeBetweenFlightsEnforcement: true upgradeDepartureTimeLimit: 01:00:00 upgradeCabinStartOffset: 208.08:00:00 minimumTimeBetweenFlights: 00:00:00 modifyPassiveSegmentTimes: true allowSellOfFlightOverlap: false availabilityMaxDate: '9999-12-31T23:59:59.9999999' allowedFareOverrideType: 2 allowMoveOnInitialBooking: false allowDowngrade: true allowDowngradeOverbook: 3 allowRestoreOverbook: 0 enableCheckValidPrice: true enableTroubleshootingButton: true servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/customerPrograms: get: tags: - settings summary: Gets customer program settings. description: 'GraphQL endpoint: settingsCustomerProgram' operationId: nsk_v1_settings_customerPrograms_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerProgramSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/eTickets: get: tags: - settings summary: Gets the non-role based e-ticket configuration. description: 'GraphQL endpoint: settingsETickets' operationId: nsk_v1_settings_eTickets_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfETicketConfiguration' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/externalMessageControls: get: tags: - settings summary: Gets the external message control settings. description: 'GraphQL endpoint: settingsExternalMessageControls' operationId: nsk_v1_settings_externalMessageControls_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfExternalMessageControls' examples: Retrieve External Message Controls Settings: description: Example response for successfully retrieving the external message controls settings value: data: carrierCodes: - NV - AD - JQ - '40' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/general/applicationLogon: get: tags: - settings summary: Retrieves the logon settings. description: 'GraphQL endpoint: settingsApplicationLogon' operationId: nsk_v1_settings_general_applicationLogon_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfLogonSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/general/codes: get: tags: - settings summary: Retrieves the codes settings. description: 'GraphQL endpoint: settingsCodes' operationId: nsk_v1_settings_general_codes_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCodesSettings' examples: Retrieve Code Settings: description: Example response for successfully retrieving the code settings value: data: allowedPaymentMethodsForFraudPrevention: a3\ExternalAccount: true aC\PrePaid: false automaticMoveNestOverbookClasses: - ASCAR - AD - XY editableRuleTypes: - AgencyPOSControls - AvailabilitySource - BaggageAllowance - BaggageCheckInRestrictionContext - BaggageJourneyMarketRank - BarcodeFastTrackConfiguration externalPaymentValidationOverrides: a3\ExternalAccount: true aC\PrePaid: false overrideFeeTypes: - 2 - 3 - 4 - 5 - 6 paymentFieldOverrides: a3\ExternalAccount: amount: 1 accountNumber: 1 cvv: 0 privateTravelQueueCategory: 1 publicTravelQueueCategory: 2 refundablePaymentMethodCodes: - A3\ExternalAccount - AC\PrePaid - AG\AgencyAccount - AP\ExternalAccount spoilFeeTypes: - 1 - 3 - 4 - 5 - 6 classOfServices: - AC - BA - CC depositPaymentTypes: - A3\ExternalAccount - AC\PrePaid - AG\AgencyAccount - AP\ExternalAccount fareTypes: - R - AP - B - C - D - DE - DF - DG - EX - F - FC - M - PE - S - SH - SL - US - W - X passengerDiscountCodes: - 5P - ADT - ALPX - CHLD - CORP - EXT - FRQF - INET - MLTY - NK1 - NK2 - NK3 - NK4 - SNR - VIP passengerTypeCodes: - ADT - CHD - INF - MLT - SRC paymentMethodCodes: - A3\ExternalAccount - AC\PrePaid - AG\AgencyAccount - AP\ExternalAccount - AX\ExternalAccount - BN\ExternalAccount penaltyFeeCodes: - AFLY - APOPF - CGX - CHF1 - CHG productClasses: - 2C - 2Y - A1 - A2 - A3 - A4 queueCategoryCodes: a: 1 b: 2 c: 3 sellSsrCodes: - 1BAG - 1BGP - 2BAG - 2BGP serviceFeeCodes: - AKFEE1 - APOSF - APOSFC - ASFE standbyClassOfServiceCodes: - AC - BA - CC stationCategories: - A - B - C viewableSeatProperties: - AISLE - AMBIANCE/SOCIAL - AMBIANCE/BUSINESS - AMBIANCE/FAMILY waiveFeeTypes: - 1 - 3 - 4 - 5 - 6 defaultFareType: R servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/general/operations: get: tags: - settings summary: Retrieves the operations settings. description: 'GraphQL endpoint: operationsSettings' operationId: nsk_v1_settings_general_operations_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. 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' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' 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 '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOperationsSettings' examples: Retrieve Operations Settings: description: Example response for successfully retrieving the operations settings value: data: overrideOverWingExitRowRequirement: true iropFromDepartureDateOffset: 10.00:00:00 allowDiversionIrop: true allowConsoleIrop: true allowCreateAdHocConnectionsInIrop: true allowIropOversellOnToFlight: true flightFollowingAccessControl: 7 allowAircraftMishapUtilityAccess: true allowCheckedBaggageWeightChange: true allowOpeningOfClosedFlights: true timeBeforeDepartureThatCloseFlightIsAllowed: 10.00:00:00 timeAfterDepartureThatOpenFlightIsAllowed: 10.00:00:00 allowClearPassengerDataInAircraftMishap: true allowRestorePassengerDataInAircraftMishap: true allowInventoryStatusChange: true adHocFromCurrentDateOffset: 10.00:00:00 bagDropMode: 0 allowCrewBagAccess: true allowRushBagAccess: true allowCrewBagCheckInWhenFlightIsClosedPending: true allowRushBagCheckInWhenFlightIsClosedPending: true allowMarketingCheckIn: true verifyAPISInternationalFlight: true allowInventorySSRMaintenanceUpdate: true allowInventoryRecordMaintenanceUpdate: true allowCancelRestoreInventory: true allowDiversionAdHoc: true allowManageTailNumber: true allowEquipmentSwapUtilityAccess: true allowRZAccess: true allowUpdateStandbyPriorityCode: true allowManageVoucher: true flightInformationPermissions: 1 allowSegmentsByTime: true allowBaggageTrackingAccess: true enableFlightSearchRestrictionByOrigin: true allowBaggageModeSwitchToIBCMode: true daysForwardAllowedForSearchingCheckInAndReports: 30.00:00:00 daysPriorAllowedForSearchingCheckInAndReports: 30.00:00:00 sendAPISReport: true watchList: allowViewForWatchList: true allowDetailViewForWatchList: true allowClearPassengerFromWatchList: true programs: sendSITAMessage: true sendMessage: true adHocScheduleInventoryConnections: true allowCAPPSReportAccess: true allowCheckInSelectee: true reports: enplanementDeplanement: true manifestConnectionInfo: true manifestDetailedInfo: true flightLoad: true checkIn: true aircraftZone: true seatAssignment: true flightClose: true paymentReceipt: true paymentReceiptConfigurations: displayLocationPrompt: true checkedBaggage: true availability: true bagWeightByLeg: true selecteesByFlight: true mealFulfillment: true flightManifest: true flightManifestConfigurations: identifySelecteePassengers: true identifyPassengersWithBalanceDue: true prePostFlightManifest: true cabinServiceArea: true displayPNRInCabinServiceAreaAndMealFulfillmentReports: true servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/general/organization: get: tags: - settings summary: Gets the organization settings. description: 'GraphQL endpoint: settingsOrganization' operationId: nsk_v1_settings_general_organization_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/general/session: get: tags: - settings summary: Retrieves the session settings. description: 'GraphQL endpoint: settingsSession' operationId: nsk_v1_settings_general_session_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSessionSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/itinerary: get: tags: - settings summary: Gets the itinerary settings. description: 'GraphQL endpoint: itinerarySettings' operationId: nsk_v1_settings_itinerary_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfItinerarySettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/loyalty: get: tags: - settings summary: Gets the non-role based loyalty settings. description: 'GraphQL endpoint: settingsLoyalty' operationId: nsk_v1_settings_loyalty_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfLoyaltySettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/notifications/general: get: tags: - settings summary: Gets the general New Skies notification settings. description: 'GraphQL endpoint: settingsGeneralNotifications' operationId: nsk_v1_settings_notifications_general_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGeneralNotificationsSettings' examples: Retrieve Notifications Settings: description: Example response for successfully retrieving the notifications settings value: data: enableTicketControlNumberNotifications: true servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/payment: get: tags: - settings summary: Get the non role based payment settings. description: 'GraphQL endpoint: settingsPayment' operationId: nsk_v1_settings_payment_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentSettings' examples: Retrieve General Payment Settings Response: description: Example response for successfully retrieving the general payment settings. value: data: defaultCommentForCreditShell: comment webDeclinedPaymentHoldPeriod: 15 directDeclinedPaymentHoldPeriod: 1 gdsDeclinedPaymentHoldPeriod: 11 apiDeclinedPaymentHoldPeriod: 2 autoCancelChargeBackPaymentHolds: true allowZeroAmountFormOfPayment: true includeInFirstInstallmentFeeCodes: - PF01 - PFAU5 - PFAU6 retainHoldStatusUntilPaymentAuthorization: true validateCurrencyEnforcedAgainstPaymentType: 1 numberOfDeclinedRefundAndReverseAttempts: 0 servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/phoneNumberValidation: get: tags: - settings summary: Gets the non-role based phone number validation settings. description: 'GraphQL endpoint: settingsPhoneNumberValidation' operationId: nsk_v1_settings_phoneNumberValidation_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPhoneNumberValidationSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/settings/premiumServices: get: tags: - settings summary: Retrieves the premium services settings. description: 'GraphQL endpoint: settingsPremiumServicesv2' operationId: nsk_v2_settings_premiumServices_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPremiumServicesSettingsv2' examples: Retrieve Premium Services Settings: description: Example response for successfully retrieving the premium services settings value: data: governmentDataProtectionRequirements: true accessToExternalBaggageSystems: true unitedKingdomInteractiveAdvancePassengerProcessing: true advancedParentChildTravelAgencyManagement: true doNotPersistExternalPaymentDetails: false baggageSelfTagging: true loyaltyCustomerAccountView: true pricingOptimizationServices: true secureFlight: true allInclusivePricingDisplay: true numericAddressVerificationService: true koreanInteractiveAdvancePassengerProcessing: true taiwanInteractiveAdvancePassengerProcessing: true canadaInteractiveAdvancePassengerProcessing: true attributeShopping: true documentCheckConfiguration: true transmitFareDataToAirlineTariffPublishingCompany: true travelNotifications: true bundles: true put: tags: - settings summary: BETA - Edit the premium service settings. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. This functionality is restricted to System Master users only.' operationId: nsk_v2_settings_premiumServices_put requestBody: x-name: request description: The new booking payment settings. content: application/json: schema: $ref: '#/components/schemas/PremiumServicesSettingsv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/serviceBundles: get: tags: - settings summary: Gets the service bundles settings. description: 'GraphQL endpoint: settingsServiceBundles' operationId: nsk_v1_settings_serviceBundles_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfServiceBundlesSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v2/settings/skySpeed: get: tags: - settings summary: Retrieves the role-based and non-role based SkySpeed settings. description: 'GraphQL endpoint: settingsSkySpeedv2' operationId: nsk_v2_settings_skySpeed_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSkySpeedSettingsv2' examples: Retrieve SkySpeed Settings v2: description: Example response for successfully retrieving the SkySpeed settings v2 value: data: disableBaseCurrency: false manifestViewDate: 0 disableOutboundTime: true maximumNumberOfTtyMessagesPerBatchForDeletion: 1000 excludeOutboundTimeTab: true postalCodeLookup: 0 disableReturnTime: true serviceServerName: 0 excludeReturnTimeTab: true enableViewPaymentAllocation: true enableShowValidFaresCheckbox: true fareBasisInRegularBooking: 9 fareBasisInOverbook: 9 displayReservedFlights: true displaySsrNestValues: true defaultFocusToCustomerIdField: true allowDeleteComments: true promptCreateInternetUserId: true allowManagePasswordForCustomerAccount: true viewFareQuote: true allowNonCarrierOrgToUseOtherAgency: true viewTeletypeProcessing: true viewGdsHistoryDialog: true returnDateDefaultToOutboundDate: true displayFyiNotesOnLogin: true displayResidentCountry: true displayPricesByPassengerType: null defaultToCustomerCreditCard: true forceViewMandatoryComments: true showTravelDocumentsOnPassengersScreen: true showDestinationAddressesOnPassengersScreen: true showFrequentFlyerNumberOnPassengersScreen: true showMealSsrButtonOnPassengersScreen: true allowETicketing: true allowFeesToBeDeleted: true displayReferenceNumber: true enableLoyaltyCustomerAccountView: true enableLoyaltyFareDisplay: true displayETicketRecords: true allowETicketCouponStatusToBeUpdated: true enableRepriceButtonOnReservedFlightsScreen: true enableSplitCancelButtonOnReservedFlightsScreen: true allowTravelNotificationsAccess: true allowThemeEditorAccess: true allowBlacklistAccessAndRetrieveReservationsFromPayments: true maskBookingContactInformation: false accessToFlightsWithTrafficRestrictions: true enabledTicketCodes: null reservationComments: null itineraryComments: null manifestComments: null enableDeletePassengerButton: true showMultiCityShoppingTabOnAvailabilityRequestScreen: true allowTcpOnDemand: true servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/system/general: get: tags: - settings summary: Gets the role-based general system settings. description: 'GraphQL endpoint: settingsGeneralSystem' operationId: nsk_v1_settings_system_general_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Settings not found.: description: Example when the settings cannot be retrieved. value: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Matching ETag: description: Response when an ETag is provided and the cached data still matches. value: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGeneralSystemSettings' examples: Retrieve General System Settings: description: Example response for successfully retrieving the general system settings value: data: manageFYIContent: 7 manageGeneralReferenceManagement: 7 allowAccessToFyiContent: true manageQueues: 7 allowAgentToEmptyBookingQueues: true servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/systemConfiguration/finance: get: tags: - settings summary: Retrieves the session system configuration finance setting. description: 'GraphQL endpoint: systemConfigurationFinance' operationId: nsk_v1_settings_systemConfiguration_finance_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: - string - 'null' maxLength: 4 minLength: 1 x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFinanceSettings' examples: Retrieve System Configuration Finance: description: Example response for successfully retrieving the system configuration - finance settings value: data: financeAccess: 7 financeData: manageAccounts: 2 manageCreditTypes: 6 manageCurrency: 4 manageFareDiscountCodes: 0 manageFareSurcharges: 1 managePaymentTypes: 5 managePromotionCodes: 7 manageTaxesAndFees: 1 allowAgentToImportFeeVariations: true manageVouchers: 1 allowAccountReconciliation: true allowBalanceAndCreditLimitUpdate: true allowAccountStatementAdjustment: true manageFinancialControlLockDate: 0 servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/travelerNotification: get: tags: - settings summary: Gets the traveler notification settings. description: 'GraphQL endpoint: settingsTravelerNotification' operationId: nsk_v1_settings_travelerNotification_get parameters: - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTravelerNotificationSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/user/agencyCreation: get: tags: - settings summary: Retrieves the agency creation settings. description: 'GraphQL endpoint: settingsAgencyCreation' operationId: nsk_v1_settings_user_agencyCreation_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAgencyCreationSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/nsk/v1/settings/user/customerCreation: get: tags: - settings summary: Retrieves the customer creation settings. description: 'GraphQL endpoint: settingsCustomerCreation' operationId: nsk_v1_settings_user_customerCreation_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerCreationSettings' servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground /api/dcs/v2/settings/operations/checkin: get: tags: - settings summary: Gets check-in settings for the current user's role code. description: 'GraphQL endpoint: dcsGetCheckinSettingsV2' operationId: dcs_v2_settings_operations_checkin_get responses: '200': description: The check-in settings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinSettingsV2' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse_2' servers: - url: https://prod.api.tui/flight/newskies/gonow description: TUI Prod - url: https://playground.api.tui/flight/newskies/gonow description: TUI Playground /api/dcs/v1/settings/operations/departure: get: tags: - settings summary: Gets departure settings for the current user's role code. description: 'GraphQL endpoint: dcsGetDepartureSettings' operationId: dcs_v1_settings_operations_departure_get responses: '200': description: The departure settings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDepartureSettings' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse_2' servers: - url: https://prod.api.tui/flight/newskies/gonow description: TUI Prod - url: https://playground.api.tui/flight/newskies/gonow description: TUI Playground /api/dcs/v1/settings/operations/deviceManager: post: tags: - settings summary: Gets settings for the device manager. description: 'GraphQL endpoint: dcsGetDeviceManagerSettings' operationId: dcs_v1_settings_operations_deviceManager_post requestBody: x-name: request description: The request for device manager settings. content: application/json: schema: $ref: '#/components/schemas/DeviceManagerSettingsRequest' required: true x-position: 1 responses: '200': description: The device manager settings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse_2' servers: - url: https://prod.api.tui/flight/newskies/gonow description: TUI Prod - url: https://playground.api.tui/flight/newskies/gonow description: TUI Playground /api/dcs/v1/settings/operations/kiosk: get: tags: - settings summary: Gets kiosk settings. description: 'GraphQL endpoint: dcsGetKioskSettings' operationId: dcs_v1_settings_operations_kiosk_get responses: '200': description: The kiosk settings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfKioskSettings' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse_2' servers: - url: https://prod.api.tui/flight/newskies/gonow description: TUI Prod - url: https://playground.api.tui/flight/newskies/gonow description: TUI Playground /api/dcs/v1/settings/operations/reports: get: tags: - settings summary: Gets report settings for the current user's role code. description: 'GraphQL endpoint: dcsGetReportSettings' operationId: dcs_v1_settings_operations_reports_get responses: '200': description: The report settings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfReportsSettings' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse_2' servers: - url: https://prod.api.tui/flight/newskies/gonow description: TUI Prod - url: https://playground.api.tui/flight/newskies/gonow description: TUI Playground components: schemas: IJsonResponseOfAgencyCreationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/AgencyCreationSettings' 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' CustomerCreationSettings: type: object description: "Settings for creating customers.\n " additionalProperties: false properties: organization: type: - string - 'null' description: "Gets or sets the default Customer organization for new customer.\n " maxLength: 10 minLength: 0 domain: type: - string - 'null' description: "Gets or sets the default Domain for new customer.\n " maxLength: 5 minLength: 0 department: type: - string - 'null' description: "Gets or sets the default Department for new customer.\n " maxLength: 4 minLength: 0 role: type: - string - 'null' description: "Gets or sets the default Role for new customer.\n " maxLength: 4 minLength: 1 location: type: - string - 'null' description: "Gets or sets the default Location value for new customer.\n " maxLength: 5 minLength: 0 minimumAge: type: integer description: "Gets or sets the minimum age for a new customer.\n " format: int32 maximum: 32767.0 minimum: 0.0 enableCheckDigit: type: boolean description: "Gets or sets the flag that enables the check digit algorithm.\n " allowPropertyBagUpload: type: boolean description: "Gets or sets the flag that allows bag property uploads.\n " maximumPersonInfoSize: type: - integer - 'null' description: "Gets or sets the maximum size of the person info.\n " format: int64 allowDuplicateCustomerName: type: boolean description: "Gets or sets the flag allowing duplicate customer names.\n " FieldControlType: type: integer description: "Defines the different field validation types.\n \n\n0 = Required\n1 = Optional\n2 = Disabled\n3 = RequiredMasked\n4 = OptionalMasked" x-enumNames: - Required - Optional - Disabled - RequiredMasked - OptionalMasked enum: - 0 - 1 - 2 - 3 - 4 LogonSettings: type: object description: "The logon settings.\n " additionalProperties: false properties: allowConsoleReservations: type: boolean description: "A flag that allows logon for the connected Console application.\n " allowDepartureControlSystem: type: boolean description: "A flag that allows logon through the Departure Control System.\n " allowWebReporting: type: boolean description: "A flag that allows logon for the connected web reporting application.\n " allowWebReservations: type: boolean description: "A flag that allows logon for the connected web reservations application.\n " allowWebServicesApi: type: boolean description: "A flag that allows logon for the connected web services API.\n " allowExternalSystemServices: type: boolean description: "A flag that allows logon for the connected web services through an External System Communication.\n " allowWindowsFareManager: type: boolean description: "A flag that allows logon for the Fare Manager application.\n " allowWindowsManager: type: boolean description: "A flag that allows logon for the Manager application.\n " allowWindowsReservations: type: boolean description: "A flag that allows login for the Reservations application.\n " allowWindowsScheduleManager: type: boolean description: "A flag that allows login for the Schedule Manager application.\n " impersonationRoles: type: - array - 'null' description: "A list of acceptable impersonation roles for this role.\n " items: type: string overrideSystemAccessRestriction: type: boolean description: "A flag that allows overriding the system access restrictions.\n " allowDotRezCenter: type: boolean description: "A flag that indicates whether log-ons to dotREZ Center are allowed.\n " FinanceSettings: type: object description: "System configuration - finance.\n " additionalProperties: false properties: financeAccess: description: "Gets or Sets the level of access allowed on managing finance data.\n " $ref: '#/components/schemas/AccessControl' financeData: description: "Gets or Sets the finance data.\n " $ref: '#/components/schemas/FinanceSettingsData' manageFinancialControlLockDate: description: "Gets or Sets the level of access allowed in managing the financial control lock date.\n " $ref: '#/components/schemas/ClosedFlightControlDateType' CharacterSet: type: integer description: "Defines the list of supported character set used as delimiter by e-ticket parsers.\n \n\n0 = Iata\n1 = Iatb" x-enumNames: - Iata - Iatb enum: - 0 - 1 InterchangeSystem: type: object description: "The configuration data for the message delivery interchange system.\n " additionalProperties: false properties: systemCode: type: - string - 'null' description: "The IATA-assigned system code for the sending or receiving system.\n " systemCodeQualifier: type: - string - 'null' description: "The code qualifier of the sending or receiving system.\n " routingAddress: type: - string - 'null' description: "The routing address.\n " PhoneNumberValidationType: type: integer description: "Phone number validation mode enumeration.\n \n\n0 = None\n1 = FixedDigits\n2 = StringPattern" x-enumNames: - None - FixedDigits - StringPattern enum: - 0 - 1 - 2 FareClassControl: type: integer description: "Fare class control enumeration for controlling the number and type of fares applied to the search response.\n \n\n0 = LowestFareClass\n1 = CompressByProductClass\n2 = Default" x-enumNames: - LowestFareClass - CompressByProductClass - Default enum: - 0 - 1 - 2 IJsonResponseOfSessionSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SessionSettings' 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' FareSelection: type: integer description: "Identifies which fare to return from availability.\n \n\n0 = BySortPrice\n1 = ByCalculatedFarePrice" x-enumNames: - BySortPrice - ByCalculatedFarePrice enum: - 0 - 1 OverbookControl: type: integer description: "Defines the access rights to overbook.\n \n\n0 = CannotOverbook\n1 = CanOverbookClass\n2 = CanOverbookNest\n3 = CanOverbookLeg" x-enumNames: - CannotOverbook - CanOverbookClass - CanOverbookNest - CanOverbookLeg enum: - 0 - 1 - 2 - 3 IJsonResponseOfSkySpeedSettingsv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SkySpeedSettingsv2' 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' SkySpeedSettingsv2: type: object description: "Settings for Sky Speed.\n " additionalProperties: false properties: manifestViewDate: description: "The value to indicate what type of date to display in the SkySpeed manifest view.\n " $ref: '#/components/schemas/ManifestViewDateType' maximumNumberOfTtyMessagesPerBatchForDeletion: type: integer description: "The value to indicate the maximum number of TTY messages\nper batch for deletion.\n " format: int32 postalCodeLookup: description: "The value to indicate the manner in which postal codes will be looked up\nin SkySpeed.\n " $ref: '#/components/schemas/PostalCodeLookupType' serviceServerName: type: integer description: "The value to indicate the server name of the primary service.\n " format: int32 enableViewPaymentAllocation: type: boolean description: "Enable view payment allocation.\n " disableBaseCurrency: type: boolean description: "Disables base currency when searching flights.\n " disableOutboundTime: type: boolean description: "Disables outbound time when searching flights.\n " excludeOutboundTimeTab: type: boolean description: "Excludes the outbound time from tab order.\n " disableReturnTime: type: boolean description: "Disables return time when searching flights.\n " excludeReturnTimeTab: type: boolean description: "Excludes return time from tab order.\n " enableShowValidFaresCheckbox: type: boolean description: "Enable check box to 'Show Only Fares Valid for Given Number of Passengers'.\n " fareBasisInRegularBooking: type: integer description: "Indicates fare basis significance in regular booking mode.\n " format: int32 fareBasisInOverbook: type: integer description: "Indicates fare basis significance in overbook mode.\n " format: int32 displayReservedFlights: type: boolean description: "Display the reserved flights dialog after reserving a flight.\n " displaySsrNestValues: type: boolean description: "Display the SSR nest values.\n " defaultFocusToCustomerIdField: type: boolean description: "Set cursor to customer id field in add name dialog.\n " allowDeleteComments: type: boolean description: "Allow comments to be deleted.\n " promptCreateInternetUserId: type: boolean description: "Prompt to create SkySales user id after creating customer account.\n " allowManagePasswordForCustomerAccount: type: boolean description: "Allow password management for customer accounts.\n " viewFareQuote: type: boolean description: "View fare quote dialog.\n " allowNonCarrierOrgToUseOtherAgency: type: boolean description: "Allow non carrier org to use other agency.\n " viewTeletypeProcessing: type: boolean description: "View teletype processing dialog.\n " viewGdsHistoryDialog: type: boolean description: "View GDS history dialog.\n " returnDateDefaultToOutboundDate: type: boolean description: "Return date default to outbound date.\n " displayFyiNotesOnLogin: type: boolean description: "Display FYI notes on login.\n " displayResidentCountry: type: boolean description: "Display resident country control.\n " displayPricesByPassengerType: type: - array - 'null' description: "Display prices by passenger type (Restrict or Allow).\n " items: type: string defaultToCustomerCreditCard: type: boolean description: "Default payment to the first credit card of the customer.\n " forceViewMandatoryComments: type: boolean description: "Force view mandatory comments on change booking.\n " showTravelDocumentsOnPassengersScreen: type: boolean description: "Show travel document tab on the passengers screen.\n " showDestinationAddressesOnPassengersScreen: type: boolean description: "Show the destination address tab on the passengers screen.\n " showFrequentFlyerNumberOnPassengersScreen: type: boolean description: "Show the frequent flyer number tab on the passengers screen.\n " showMealSsrButtonOnPassengersScreen: type: boolean description: "Show the meal SSR button on the passengers screen.\n " allowETicketing: type: boolean description: "Allow e-ticketing.\n " allowFeesToBeDeleted: type: boolean description: "Allow fees to be deleted.\n " displayReferenceNumber: type: boolean description: "Display reference number.\n " enableLoyaltyCustomerAccountView: type: boolean description: "Enable loyalty customer account view.\n " enableLoyaltyFareDisplay: type: boolean description: "Enable loyalty fare display.\n " displayETicketRecords: type: boolean description: "Display e-ticket records.\n " allowETicketCouponStatusToBeUpdated: type: boolean description: "Allow e-ticket coupon status to be updated.\n " enableRepriceButtonOnReservedFlightsScreen: type: boolean description: "Enable reprice button on the reserved flights screen.\n " enableSplitCancelButtonOnReservedFlightsScreen: type: boolean description: "Enable reprice button on the reserved flights screen.\n " allowTravelNotificationsAccess: type: boolean description: "Allow access to traveler notification dialogs.\n " allowThemeEditorAccess: type: boolean description: "Allow theme editor access.\n " allowBlacklistAccessAndRetrieveReservationsFromPayments: type: boolean description: "Allow access to blacklist and retrieve reservations from the payment's window.\n " maskBookingContactInformation: type: boolean description: "Mask booking contact information.\n " accessToFlightsWithTrafficRestrictions: type: boolean description: "Access to flights with traffic restrictions.\n " enabledTicketCodes: type: - array - 'null' description: "List of enabled ticket codes. Note: these are only the ticket codes that are marked\nas true to display the ticket code details. Ticket codes that are marked false will\nnot be included in this list.\n " items: type: string reservationComments: type: - array - 'null' description: "Pre-defined reservation comments.\n " items: type: string itineraryComments: type: - array - 'null' description: "Pre-defined itinerary comments.\n " items: type: string manifestComments: type: - array - 'null' description: "Pre-defined manifest comments.\n " items: type: string enableDeletePassengerButton: type: boolean description: "Enable delete button on passenger screen.\n " showMultiCityShoppingTabOnAvailabilityRequestScreen: type: boolean description: "Show the Multi City Shopping Tab on the availability request screen.\n " allowTcpOnDemand: type: boolean description: "Indicates if the user is allowed to send a TCP message.\n " SharedCommentType: type: object description: "The shared comment types for the booking source.\n " additionalProperties: false properties: reservation: type: boolean description: "Indicates if the role is allowed to share the reservation comment type with the booking source.\n " itinerary: type: boolean description: "Indicates if the role is allowed to share the itinerary comment type with the booking source.\n " manifest: type: boolean description: "Indicates if the role is allowed to share the manifest comment type with the booking source.\n " alert: type: boolean description: "Indicates if the role is allowed to share the alert comment type with the booking source.\n " IJsonResponseOfCheckInSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CheckInSettings' 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' IJsonResponseOfPaymentSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PaymentSettings' 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' IJsonResponseOfBookingPaymentSettingsv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/BookingPaymentSettingsv2' 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' ReassignSeatingBehavior: type: integer description: "Enumeration with possible seat reassignment behaviors during any type of flight move.\n \n\n0 = DropSeats\n1 = LikeForLike\n2 = Algorithm\n3 = SameSeatGroup" x-enumNames: - DropSeats - LikeForLike - Algorithm - SameSeatGroup enum: - 0 - 1 - 2 - 3 AdHocFlightControl: type: integer description: "Defines the permissions for AdHoc flight operations.\n \n\n0 = None\n1 = View\n2 = Sell" x-enumNames: - None - View - Sell enum: - 0 - 1 - 2 CustomerAccountSettings: type: object description: "The booking customer account settings.\n " additionalProperties: false properties: allowCustomerMerge: type: boolean description: "The flag allowing two different customer accounts to be combined into a single account.\n " allowCustomerProgram: type: boolean description: "The flag allowing the current role to manage user customer programs.\n " allowSeatLocationOption: type: boolean description: "The flag allowing the current role to manage user seat preferences.\n " customerAccessControl: description: "The restriction/permissions allowed by the current role.\n " $ref: '#/components/schemas/CustomerAccessControl' defaultCustomerNotificationPreference: description: "The default notification preferences of the customer.\n " $ref: '#/components/schemas/NotificationPreference' defaultSeatPreference: description: "The default seat preferences of the customer.\n " $ref: '#/components/schemas/CustomerSeatPreference' disableCustomerAddress: description: "The restrictions on the customer address fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerCurrency: description: "The restrictions on the customer currency fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerDateOfBirth: description: "The restrictions on the customer date of birth fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerEmail: description: "The restrictions on the customer email fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerFax: description: "The restrictions on the customer fax fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerLanguage: description: "The restrictions on the customer language fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerNationality: description: "The restrictions on the customer nationality fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerNotificationPreference: description: "The restrictions on the customer notification preferences fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerPayment: description: "The restrictions on the customer payment fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerPhone: description: "The restrictions on the customer phone number fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerResidentCountry: description: "The restrictions on the customer resident country fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerTitle: description: "The restrictions on the customer title fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerType: description: "The restrictions on the customer type fields.\n " $ref: '#/components/schemas/FieldControlType' allowAgentToModifyProgramLevel: type: boolean description: "The flag allowing the agent to modify program level for default loyalty customer program.\n " maskCustomerName: type: boolean description: "Indicates if the customer name is masked.\n " maskCustomerSuffix: type: boolean description: "Indicates if the customer suffix is masked.\n " maskTravelDocumentDetails: type: boolean description: "Indicates if the travel document details is masked.\n " maskCustomerWebUserId: type: boolean description: "Indicates if the customer web user ID is masked.\n " maskCustomerGender: type: boolean description: "Indicates if the customer gender is masked.\n " maskAffiliation: type: boolean description: "Indicates if the corporate or government affiliation is masked.\n " IJsonResponseOfETicketConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ETicketConfiguration' 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' GeneralSettings: type: object description: "The booking general settings.\n " additionalProperties: false properties: allowChangeSsrOnCheckedInPassenger: type: boolean description: "The flag allowing adding and removing SSRs on a checked-in passenger.\n " allowBlockedSeatAssignment: type: boolean description: "The flag allowing blocked seat assignment.\n " allowChangeOnRestrictedFlight: type: boolean description: "The flag allowing changing the booking on a restricted flight.\n " allowPromoCodes: type: boolean description: "The flag allowing promo codes.\n " allowEditableApiChannel: type: boolean description: "The flag allowing changes on a booking made through the API channel.\n " allowEditableDirectChannel: type: boolean description: "The flag allowing changes on a booking made through the direct channel.\n " allowEditableGdsBookingWithTaPayment: type: boolean description: "The flag allowing the current role to edit GDS bookings with TA payments.\n " allowEditableGdsChannel: type: boolean description: "The flag allowing the current role to edit bookings created through GDS.\n " allowEditableWebChannel: type: boolean description: "The flag allowing the current role to edit bookings created through the web channel.\n " allowGroupNameUpdates: type: boolean description: "The flag allowing group names to be updated on non-GDS flights.\n " allowManifestRetrievalOnUnblockedFlightLines: type: boolean description: "The flag allowing manifest retrieval on Unblocked flight lines\n " allowOverbookingSsrOnMove: type: boolean description: "The flag allowing overbooking SSRs on Move.\n " allowQueueingGdsBookingWithTaFopForETicketReissue: type: boolean description: "The flag allowing queuing GDS booking with TA FOP for ETicket Reissues.\n " allowRestrictedSeatAssignment: type: boolean description: "The flag allowing restricted seat assignments.\n " allowSeatAssignment: description: "The seat assignment rules for this role.\n " $ref: '#/components/schemas/SeatAssignmentRole' bookingAccessControl: description: "The booking access allowed on this role.\n " $ref: '#/components/schemas/BookingAccessControl' viewBookingsByControl: description: "The highest organization that the role can view bookings for.\n " $ref: '#/components/schemas/GroupAccessControl' editBookingsByControl: description: "The highest organization that the role can edit bookings for.\n " $ref: '#/components/schemas/GroupAccessControl' defaultBookingComment: type: - string - 'null' description: "The mandatory booking comment.\n " doNotIncludeUnitProperties: type: boolean description: "The flag to not include unit properties in notification itinerary.\n " duplicateBookingDetectionTimeSpan: type: - string - 'null' description: "The timespan where duplicate bookings are watched for on this role.\n " format: duration enableAutomaticSeatAssignment: type: boolean description: "The flag allowing automatic seat assignment on this role.\n " highlightFareOverride: description: "The option to highlight the fare override on this role.\n " $ref: '#/components/schemas/HighlightOption' highlightIrop: description: "The option to highlight IROP information on this role.\n " $ref: '#/components/schemas/HighlightOption' highlightScheduleChange: description: "The option to highlight schedule changes on this role.\n " $ref: '#/components/schemas/HighlightOption' highlightStandby: description: "The option to highlight standbys on this role.\n " $ref: '#/components/schemas/HighlightOption' highlightUpgrade: description: "The option to highlight upgrades on this role.\n " $ref: '#/components/schemas/HighlightOption' managePassiveSegments: type: boolean description: "The flag to allow managing passive segments on this role.\n " maskHistory: type: boolean description: "Determines if Booking, Queue and Notification History in a PNR is masked.\n " reassignSeatingBehavior: description: "The reassign seat behavior for this role.\n " $ref: '#/components/schemas/ReassignSeatingBehavior' restrictedExternalSystemCodes: type: - array - 'null' description: "Gets or sets a list of restricted external system codes for this role.\n " items: type: string timeDisplay: description: "The time display style for this role.\n " $ref: '#/components/schemas/TimeDisplay' allowSeatGroupRestrictionOverride: type: boolean description: "The allow seat group restriction override flag.\n " allowAccessToComments: type: boolean description: "The allow access to comments flag.\n " sharedCommentTypes: description: "The comment types that can be shared with the booking source.\n " $ref: '#/components/schemas/SharedCommentType' allowOverrideOfSalesChannel: type: boolean description: "The flag for allowing overriding of sales channel.\n " autoFillContactInformationByPhoneNumber: type: boolean description: "The flag that configures auto-filling and auto-saving of contact information\nwhen a phone number is provided on creating a booking for various user interfaces.\n " allowAccessToArchivedBooking: type: boolean description: "Allows a role to access archived bookings\n " allowQueueBookingsOnSpecifiedLeg: type: boolean description: "Allows a role to queue bookings on a specified leg.\n " queueFlightOpenTimeSpan: type: - string - 'null' description: "Indicates the time span before departure when flight can no longer be processed.\n " format: duration queueFlightCloseTimeSpan: type: - string - 'null' description: "Indicates the time span after departure when flight can no longer be processed.\n " format: duration allowReleaseHeldSessionSeat: type: boolean description: "The flag allowing agents to release seats held in a session.\n " FlightSearchSettings: type: object description: "The Booking flight search settings.\n " additionalProperties: false properties: bookingMaxPassengers: type: integer description: "The maximum number of passengers allowed on a single booking.\n " format: int32 allowOpenJaw: type: boolean description: "Flag that indicates if open jaw journeys are allowed.\n " allowPrivateFares: type: boolean description: "Flag that indicates whether private fares are allowed.\n " showExpiredFareDateRange: type: integer description: "The number of days after the fare discontinue date that the agent will be allowed to view the fare.\n " format: int32 maxNumberConnectingFlights: type: integer description: "The maximum number of connections on a journey that will be returned from availability.\n " primarySortKey: description: "The primary sort to be used on availability response.\n " $ref: '#/components/schemas/JourneySortKey' secondarySortKey: description: "The secondary sort to be used on the availability response.\n " $ref: '#/components/schemas/JourneySortKey' maxAvailabilityDateRange: type: integer description: "The maximum number of days between the begin and end date for regular availability.\n " format: int32 maxLowFareDateRange: type: integer description: "The maximum number of days between the begin and end date for low fare availability.\n " format: int32 displayLowerFares: description: "Display setting for low fares (used in change flow).\n " $ref: '#/components/schemas/FareDisplayType' fareClassControl: description: "The fare class filtering when returning journeys during availability.\n " $ref: '#/components/schemas/FareClassControl' allUpPricing: type: boolean description: "The flag indicating whether to allow anticipated sales taxes and travel fees when processing the availability\nrequest.\n " fareSorting: description: "Fare filtering options.\n " $ref: '#/components/schemas/FareSelection' lowFareCacheStatus: description: "The status of the low fare cache.\n " $ref: '#/components/schemas/LowFareCacheOption' sortByInterlineConnections: type: boolean description: "This maps to New Skies' Bias Online Commercial Duplicates.\nIf set to true the flight availability results are sorted by online connections (the same carrier for all legs)\nfollowed by the interline connections (between hosted carriers).\n " JourneySortKey: type: integer description: "Defines the sorting keys for the journeys on availability.\n \n\n0 = ServiceType\n1 = ShortestTravelTime\n2 = LowestFare\n3 = HighestFare\n4 = EarliestDeparture\n5 = LatestDeparture\n6 = EarliestArrival\n7 = LatestArrival\n8 = NoSort\n9 = BiasOnlineCommercialDuplicates\n10 = JourneyNumber" x-enumNames: - ServiceType - ShortestTravelTime - LowestFare - HighestFare - EarliestDeparture - LatestDeparture - EarliestArrival - LatestArrival - NoSort - BiasOnlineCommercialDuplicates - JourneyNumber enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 IJsonResponseOfCustomerCreationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CustomerCreationSettings' 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' FlightManifestReportConfigurations: type: object description: "Flight Manifest Reports Configurations sub-group of the Operations Settings (aka Department Control)\n " additionalProperties: false properties: identifySelecteePassengers: type: boolean description: "Whether or not users with this role are allowed to include selectee passengers in the report.\n " identifyPassengersWithBalanceDue: type: boolean description: "Whether or not users with this role are allowed to include passengers with balance due in the report.\n " BookingPaymentStatus: type: integer description: "Determines if the booking has been paid for or not.\n \n\n0 = New\n1 = Received\n2 = Pending\n3 = Approved\n4 = Declined\n5 = Unknown\n6 = PendingCustomerAction" x-enumNames: - New - Received - Pending - Approved - Declined - Unknown - PendingCustomerAction enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 IJsonResponseOfCodesSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CodesSettings' 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' ReserveFlightsSettings: type: object description: "The booking reserve flight settings.\n " additionalProperties: false properties: availabilityDepartureTimeLimit: type: string description: "Time limit for availability departure from current date and time.\n " format: duration availabilityMaxDaysOut: type: string description: "Time indicating when flights cannot depart or return from current date and time.\n " format: duration sellDepartureTimeLimit: type: string description: "Time indicating when flights cannot be booked/sold from current date and time.\n " format: duration availableSpaceDisplayMax: type: integer description: "The maximum available seats displayed.\n " format: int32 flightTimeChangeToleranceMinutes: type: integer description: "Number of flight time change tolerance minutes.\n " format: int32 viewCapacity: type: boolean description: "Flag indicating if whether the agent is allowed to view aircraft capacity.\n " viewLidSold: type: boolean description: "Flag indicating whether the agent is allowed to view aircraft lid and seats sold counts.\n " viewSsrAvailability: type: boolean description: "Flag indicating whether the agent is allowed to view ssr availability.\n " viewManifestControl: description: "Indicator whether the agent is allowed to view manifest.\n " $ref: '#/components/schemas/ViewManifestControl' adHocFlightControl: description: "Indicator on permissions for AdHoc flight operations.\n " $ref: '#/components/schemas/AdHocFlightControl' allowSellOverbook: description: "Indicator whether the agent is allowed to overbook except on moves.\n " $ref: '#/components/schemas/OverbookControl' allowMoveOverbook: description: "Indicator whether the agent is allowed to overbook on move only.\n " $ref: '#/components/schemas/OverbookControl' allowUpgradeOverbook: description: "Indicator whether the agent is allowed to overbook on upgrade only.\n " $ref: '#/components/schemas/OverbookControl' allowSplitJourneyMoves: type: boolean description: "Flag indicating whether the agent allows split-journey moves.\n " allowMove: description: "Indicator whether the agent is allowed to move a passenger from a flight to another without repricing.\n " $ref: '#/components/schemas/MoveFlightCode' moveByMaximumClassAvailability: type: boolean description: "Flag indicating if move by maximum class availability.\n " requireSameCityPairOnMoves: type: boolean description: "Flag indicating if same city pairs are required on move.\n " maxMoveDaysForward: type: string description: "They number of days that are allowed to move forward.\n " format: duration maxMoveDaysBack: type: string description: "The number of days that are allowed to move backwards.\n " format: duration daysBeforeIrop: type: string description: "The number of days before IROP.\n " format: duration allowFareOverride: type: boolean description: "Flag indicating whether the agent is allowed to override the fare.\n " allowClosedFlightFareOverride: type: boolean description: "Flag indicating whether the agent is allowed to override the fare of a closed or flown flight.\n " allowFareOverrideDuringDivide: type: boolean description: "Flag indicating whether the agent is allowed to override the fare of a closed or flown flight.\n " allowIgnoreRestrictions: type: boolean description: "Flag indicating whether the agent is allowed to ignore fare restrictions on end record.\n " allowInvalidPriceStatus: type: boolean description: "Flag indicating whether the agent is allowed to End record with an invalid price.\n " cancelDepartureTimeLimit: type: string description: "Denotes the time before departure when an agent can no longer change/cancel a flight.\n " format: duration seatAssignmentTimeLimit: type: string description: "Denotes the time before departure when an agent can no longer change/cancel a flight.\n " format: duration allowUpgrade: type: boolean description: "Flag indicating if upgrades are allowed.\n " allowCreateAdhocConnect: type: boolean description: "Flag indicating if AdHoc is allowed.\n " minimumTimeBetweenFlightsEnforcement: type: boolean description: "Flag indicating whether the minimum time between flights setting timespan is to be enforced.\n " upgradeDepartureTimeLimit: type: string description: "Denotes the time before departure when an agent can no longer change/cancel a flight.\n " format: duration upgradeCabinStartOffset: type: string description: "Denotes the time before departure the agent can start offering cabin upgrades.\n " format: duration minimumTimeBetweenFlights: type: string description: "Denotes the minimum time between flights allowed.\n " format: duration modifyPassiveSegmentTimes: type: boolean description: "Flag indicating whether or not flight times on unmanaged records are overwritten.\n " allowSellOfFlightOverlap: type: boolean description: "Flag indicating whether or not to support selling of overlapping flights across all booking channels.\n " availabilityMaxDate: type: string description: "Cannot book flights whose departure or return date exceeds date.\n " format: date-time allowedFareOverrideType: description: "Controls which type of fare overrides are allowed by a role.\n " $ref: '#/components/schemas/AllowedFareOverrideType' allowMoveOnInitialBooking: type: boolean description: "Flag indicating whether or not to allow a trip move for the initial (non-committed) booking.\n " allowDowngrade: type: boolean description: "Flag indicating if downgrades are allowed.\n " allowDowngradeOverbook: description: "Indicates if the agent is allowed to overbook when downgrading a class of service.\n " $ref: '#/components/schemas/OverbookControl' allowRestoreOverbook: description: "Indicates if the agent is allowed to overbook when restoring a class of service.\n " $ref: '#/components/schemas/OverbookControl' enableCheckValidPrice: type: boolean description: "Indicates if the agent is allowed to validate fare restrictions of the booking in state.\n " enableTroubleshootingButton: type: boolean description: "Indicates if the agent is allowed to troubleshoot on the flight results screen.\n " PostalCodeLookupType: type: integer description: "This enumeration represents the postal code lookup type.\n \n\n0 = None\n1 = UsZipCode" x-enumNames: - None - UsZipCode enum: - 0 - 1 TicketSettings: type: object description: "The ticket level settings for the e-ticket message content.\n " additionalProperties: false properties: applyInvoluntaryIndicatorForETicketFareCalculation: type: boolean description: "Indicates if an involuntary indicator will be included in the fare calculation as part of the ticketing message for\ninvoluntary reissue requests.\n " includeOriginalIssueDataOnETicketIssue: type: boolean description: "Indicates if the original issue data will be included in the e-ticket issue request.\n " reissueAllUnusedCoupons: type: boolean description: "If set to true, all unflown segment ticket coupons are reissued during involuntary reissue.\nOtherwise, only unflown segment ticket coupons caused by schedule change or re-accommodations and impacted coupons\nwill be reissued.\n " useCityCodeForFareCalculationAndOdi: type: boolean description: "If set to true, the fare calculation will be generated using the configured city code for the station code.\n " endorsementComment: description: "The issue and reissue endorsement comment.\n " $ref: '#/components/schemas/EndorsementComment' baseFareRoundingUnits: type: - array - 'null' description: "The collection of base fare currency codes and rounding units.\n " items: $ref: '#/components/schemas/BaseFareRoundingUnit' IJsonResponseOfItinerarySettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ItinerarySettings' 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' BagDropMode: type: integer description: "This enumeration represents the bag drop modes.\n \n\n0 = Normal\n1 = Advanced" x-enumNames: - Normal - Advanced enum: - 0 - 1 GeneralSystemSettings: type: object description: "The general system settings.\n " additionalProperties: false properties: manageFYIContent: description: "The allowed access control for managing FYI content.\n " $ref: '#/components/schemas/AccessControl' manageGeneralReferenceManagement: description: "The allowed access control for managing contents.\n " $ref: '#/components/schemas/AccessControl' allowAccessToFyiContent: type: boolean description: "Indicates whether access to FYI content dialog or application is allowed.\n " manageQueues: description: "The allowed access control for managing queues.\n " $ref: '#/components/schemas/AccessControl' allowAgentToEmptyBookingQueues: type: boolean description: "Indicates whether agents with access to manage queues (set to `All`) are allowed to empty booking queues.\n " LoyaltyAutoEnrollment: type: integer description: "Defines the loyalty auto enrollment setting.\n \n\n0 = None\n1 = Always\n2 = Auto\n3 = AutoCreate" x-enumNames: - None - Always - Auto - AutoCreate enum: - 0 - 1 - 2 - 3 IJsonResponseOfPhoneNumberValidationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PhoneNumberValidationSettings' 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' 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 ProgramsSettings: type: object description: "Programs Settings sub-group of Operations Settings (aka Department Control)\n " additionalProperties: false properties: sendSITAMessage: type: boolean description: "Whether or not users with this role are allowed to send SITA (Société Internationale de Télécommunications\nAéronautiques) messages.\n " sendMessage: type: boolean description: "Whether or not users with this role are allowed to send messages (not through the SITA system) to other stations\nand printers.\n " adHocScheduleInventoryConnections: type: boolean description: "Whether or not users with this role are allowed to create an ad/hoc Flight and build connections to it.\n " allowCAPPSReportAccess: type: boolean description: "Whether or not users with this role are allowed access to the CAPPS (Computer-Assisted Passenger Pre-screening\nSystem) report.\n " allowCheckInSelectee: type: boolean description: "Whether or not users with this role are allowed to check-in selectee passengers.\n " IJsonResponseOfPremiumServicesSettingsv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PremiumServicesSettingsv2' 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' ClosedFlightControlDateType: type: integer description: "This enumeration represents the closed flight control date type.\n \n\n0 = ViewDate\n1 = ViewAndMoveDateForward\n2 = ViewAndMoveDateForwardOrBackward" x-enumNames: - ViewDate - ViewAndMoveDateForward - ViewAndMoveDateForwardOrBackward enum: - 0 - 1 - 2 BookingPaymentSettingsv2: type: object description: "The booking payment settings.\n " additionalProperties: false properties: allowExternalPaymentChargeBack: type: boolean description: "The flag to allow approved external payment charge back.\n " allowHoldDateOverride: type: boolean description: "The flag to allow overriding the hold dates.\n " allowIgnoreVoucherRestrictions: type: boolean description: "The flag to allow ignoring voucher restrictions.\n " allowVoucherIssuance: type: boolean description: "The flag to allow issuing vouchers.\n " allowManualAuthorization: type: boolean description: "The flag to manually authorize credit cards.\n " allowOverPay: type: boolean description: "The flag to allow overpayment.\n " allowUnderPay: type: boolean description: "The flag to allow underpayment.\n " allowUnvoidVoucher: type: boolean description: "The flag to allow unvoiding vouchers.\n " allowUseOfBinFraudTool: type: boolean description: "The flag to allow use of BIN fraud tool.\n " allowVoidVoucher: type: boolean description: "The flag to allow voided vouchers.\n " enableAutoPaymentVerification: type: boolean description: "The flag to enable auto-payment verification.\n " allowConfirmBookingWithPartialTicketing: type: boolean description: "The flag to allow confirming booking with partial ticketing.\n " allowUnmaskingCreditCardNumber: type: boolean description: "The flag to allow displaying the full credit card number without masking.\n " allowDisplayNoPaymentWarning: type: boolean description: "The flag to allow displaying a no payment warning.\n " requirePassengerOrContactForCreditFile: type: boolean description: "The flag to require passengers or contacts for a credit file.\n " requirePassengerOrContactForCreditShell: type: boolean description: "The flag to require passengers or contacts for a credit shell.\n " requireCommentsForCreditShell: type: boolean description: "The flag to require comments for credit shell.\n " disableAlternateAgAccount: type: boolean description: "The flag to disable alternative AG accounts.\n " creditShellCreditCode: type: - string - 'null' description: "The credit shell credit code.\n " maxInstallmentOverride: type: integer description: "Gets or sets a max number of installment overrides.\n " format: int32 maximum: 999.0 minimum: 0.0 maxPaymentQueries: type: integer description: "The max number of payment queries.\n " format: int32 maximum: 10000.0 minimum: 1.0 secondsTillStartPaymentQuery: type: integer description: "The number of seconds till the payment query starts.\n " format: int32 maximum: 10000.0 minimum: 2.0 secondsTillRepeatPaymentQuery: type: integer description: "The number of seconds till the payment query repeats.\n " format: int32 maximum: 10000.0 minimum: 3.0 holdsDaysBeforeDeparture: type: - string - 'null' description: "The duration for a hold before booking date.\n " format: duration holdsDaysAfterDeparture: type: - string - 'null' description: "The duration for a hold after booking date.\n " format: duration allowPendingCustomerActionAuthorization: type: boolean description: "The flag to allow authorization of a pending customer action payment.\n " allowManualAuthorizationOfPendingPaymentWithoutValidation: type: boolean description: "Indicates whether the user is allowed to approve payments\nwith Pending status.\n " maskPaymentFields: type: boolean description: "Mask the payment fields.\n " allowManualAuthorizationOfPaymentStatuses: type: - array - 'null' description: "The collection of payment status that can be manually authorized.\n " items: $ref: '#/components/schemas/BookingPaymentStatus' displayVoucherNumber: type: boolean description: "Display the voucher reference number.\n " allowOverPayWithVoucherPayment: type: - boolean - 'null' description: "Whether to allow overpayment with the voucher payment method.\n " allowVoucherOwnerUpdate: type: - boolean - 'null' description: "Indicates whether the user is allowed to update the voucher owner.\n " CustomerSeatPreference: type: integer description: "Enumeration for seat preferences.\n \n\n0 = None\n1 = Window\n2 = Aisle\n3 = NoPreference\n4 = Front\n5 = Rear\n6 = WindowFront\n7 = WindowRear\n8 = AisleFront\n9 = AisleRear" x-enumNames: - None - Window - Aisle - NoPreference - Front - Rear - WindowFront - WindowRear - AisleFront - AisleRear enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 SystemDetails: type: object description: "The configuration data for the e-ticket point of sale system details.\n " additionalProperties: false properties: originatorType: type: - string - 'null' description: "The originator type.\n " stationCode: type: - string - 'null' description: "The station code of the system that initiates the message.\nCan also be referred to as Place Location Identifier or Location Code.\n " TbaPassengersAllowed: type: integer description: "Defines the TBA passengers allowed enumeration.\n \n\n0 = Never\n1 = IfFirstPassengerIsKnown\n2 = Always" x-enumNames: - Never - IfFirstPassengerIsKnown - Always enum: - 0 - 1 - 2 CouponSettings: type: object description: "The coupon level settings for the e-ticket message content.\n " additionalProperties: false properties: applyFareDiscountToInfant: type: boolean description: "If true, the infant will inherit the fare discount code of the adult and append the fare discount code with\n'IN'. Otherwise, the lap infant designator will contain 'IN' plus the percentage of discount applied from the\npublished fare (ex. IN90).\n " bagQuantity: type: integer description: "The number of bags allowed per passenger.\n " format: int32 AgencyCreationSettings: type: object description: "Settings for creating agencies.\n " additionalProperties: false properties: department: type: - string - 'null' description: "The default Department for new agency.\n " maxLength: 4 minLength: 0 role: type: - string - 'null' description: "The default Role for new agency.\n " maxLength: 4 minLength: 1 domainCode: type: - string - 'null' description: "The default Domain for new agency.\n " maxLength: 5 minLength: 0 domainName: type: - string - 'null' description: "The default Domain name for new agency.\n " domainLocation: type: - string - 'null' description: "The default domain Location value for new agency.\n " channelType: description: "The default channel type for new agency.\n " $ref: '#/components/schemas/ChannelType' notificationEmailAddress: type: - string - 'null' description: "The default notification email address for new agency.\n " masterRole: type: - string - 'null' description: "The default master role for the new agency.\n " phoneType: description: "The default phone type for the new agency.\n " $ref: '#/components/schemas/PhoneNumberType' PhoneNumberType: type: integer description: "Defines the types of phone numbers. Note: New Skies does not support Mobile for booking contacts.\n \n\n0 = Other\n1 = Home\n2 = Work\n3 = Mobile\n4 = Fax" x-enumNames: - Other - Home - Work - Mobile - Fax enum: - 0 - 1 - 2 - 3 - 4 ContactSettings: type: object description: "The booking contact settings.\n " additionalProperties: false properties: title: description: "Title field validation control.\n " $ref: '#/components/schemas/FieldControlType' firstName: description: "First name field validation control.\n " $ref: '#/components/schemas/FieldControlType' middleName: description: "Middle name field validation control.\n " $ref: '#/components/schemas/FieldControlType' lastName: description: "Last name field validation control.\n " $ref: '#/components/schemas/FieldControlType' suffix: description: "Suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' addressLineOne: description: "Address line one field validation control.\n " $ref: '#/components/schemas/FieldControlType' addressLineTwo: description: "Address line two field validation control.\n " $ref: '#/components/schemas/FieldControlType' addressLineThree: description: "Address line three field validation control.\n " $ref: '#/components/schemas/FieldControlType' city: description: "Address city field validation control.\n " $ref: '#/components/schemas/FieldControlType' state: description: "Address state field validation control.\n " $ref: '#/components/schemas/FieldControlType' postalCode: description: "Address postal code field validation control.\n " $ref: '#/components/schemas/FieldControlType' country: description: "Address country field validation control.\n " $ref: '#/components/schemas/FieldControlType' email: description: "Email field validation control.\n " $ref: '#/components/schemas/FieldControlType' homePhoneNumber: description: "Home phone number field validation control.\n " $ref: '#/components/schemas/FieldControlType' workPhoneNumber: description: "Work phone number field validation control.\n " $ref: '#/components/schemas/FieldControlType' otherPhoneNumber: description: "Other phone number field validation control.\n " $ref: '#/components/schemas/FieldControlType' faxNumber: description: "Fax number field validation control.\n " $ref: '#/components/schemas/FieldControlType' disablePhoneFormat: type: boolean description: "Flag indicating to disable phone number formatting.\n " defaultItineraryDistribution: description: "The default itinerary distribution option.\n " $ref: '#/components/schemas/DistributionOption' notificationPreference: description: "Notification preference field validation control.\n " $ref: '#/components/schemas/FieldControlType' defaultNotificationPreference: description: "The default notification preference.\n " $ref: '#/components/schemas/NotificationPreference' defaultToCustomerPreference: type: boolean description: "Flag indicating to default the customer preferences to the contact.\n " maskContactLanguage: type: boolean description: "Gets or Sets the indicator whether contact language is masked.\n " maskIndiaGSTInfo: type: boolean description: "Gets or Sets the indicator whether contact language is masked.\n " 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 PaymentReceiptReportConfigurations: type: object description: "Reports Settings sub-group of the Operations Settings (aka Department Control)\n " additionalProperties: false properties: displayLocationPrompt: type: boolean description: "Whether or not users with this role need to display the location prompt for the payment receipt reports.\n " OperationsSettings: type: object description: "The operations settings, also known as Departure Control settings.\n " additionalProperties: false properties: overrideOverWingExitRowRequirement: type: boolean description: "The role setting to allow/disallow overriding over-wing exit row requirement.\n " iropFromDepartureDateOffset: type: string description: "Indicates the number of days prior to the current date a flight can depart and still\nhave passengers moved under IROP by those with a particular role.\n " format: duration allowDiversionIrop: type: boolean description: "In order to access the diversion functionality in IROP, agent must be\nassigned this permission.\n " allowConsoleIrop: type: boolean description: "Allows users with this role access to access IROP utility through the Console.\n " allowCreateAdHocConnectionsInIrop: type: boolean description: "Select to enable users with this role to create ad hoc connections through the IROP\nutility. If an agent does not have this permission, they are only able to choose 'r;To Flight'\nconnection options if they are already available in the Flight schedule.\n " allowIropOversellOnToFlight: type: boolean description: "Whether an IROP oversell is allowed or not.\n " flightFollowingAccessControl: description: "The access to flight following information allowed on this role.\n " $ref: '#/components/schemas/AccessControl' allowAircraftMishapUtilityAccess: type: boolean description: "Whether Aircraft Mishap Utility Access is allowed or not.\n " allowCheckedBaggageWeightChange: type: boolean description: "Whether Checked Baggage Weight Change is allowed.\n " allowOpeningOfClosedFlights: type: boolean description: "Whether opening of closed flights is allowed or not.\n " timeBeforeDepartureThatCloseFlightIsAllowed: type: string description: "Indicates the time before departure that close flight is allowed.\n " format: duration timeAfterDepartureThatOpenFlightIsAllowed: type: string description: "Indicates the time before departure that open flight is allowed.\n " format: duration allowClearPassengerDataInAircraftMishap: type: boolean description: "Whether clearing passenger data in the event of an aircraft mishap is allowed or not.\n " allowRestorePassengerDataInAircraftMishap: type: boolean description: "Whether restoring passenger data in the event of an aircraft mishap is allowed or not.\n " allowInventoryStatusChange: type: boolean description: "Whether changing the flight status is allowed or not. This is mainly used for setting flights to closed or closed\npending status. This does not allow opening a flight, for opening a flight see the AllowOpeningOfClosedFlights\nsetting\n " adHocFromCurrentDateOffset: type: string description: "Indicates the number of days before and after the current date for which ad hoc Flights can be created. For\nexample, if set to one, agents can create an ad hoc Flight for tomorrow but not further out.\n " format: duration bagDropMode: description: "Indicates whether the bag drop mode is Normal or Advanced. If set to Advanced, passenger and number of bags is\ndisplayed for the user when a boarding pass is scanned.\n " $ref: '#/components/schemas/BagDropMode' allowCrewBagAccess: type: boolean description: "Whether or not users with this role has access to the CREW bag options for crew baggage that is being checked in.\n " allowRushBagAccess: type: boolean description: "Whether or not users with this role has access to the RUSH bag options for mishandled baggage that must be\nexpedited.\n " allowCrewBagCheckInWhenFlightIsClosedPending: type: boolean description: "Whether or not users with this role can check-in baggage with CREW tag on a flight with \"Closed Pending\" status.\n " allowRushBagCheckInWhenFlightIsClosedPending: type: boolean description: "Whether or not users with this role can check-in baggage with RUSH baggage tags on a flight with \"Closed Pending\"\nstatus.\n " allowMarketingCheckIn: type: boolean description: "Whether or not users with this role are allowed to check-in passengers of marketing flights.\n " verifyAPISInternationalFlight: type: boolean description: "Whether or not users with this role are allowed to set international Flights verified in APIS.\n " allowInventorySSRMaintenanceUpdate: type: boolean description: "Whether or not users with this role are allowed to access the Inventory SSR Maintenance Update.\n " allowInventoryRecordMaintenanceUpdate: type: boolean description: "Whether or not users with this role are allowed to access the Inventory Record Maintenance Update utility.\n " allowCancelRestoreInventory: type: boolean description: "Whether or not users with this role are allowed to cancel and restore inventory.\n " allowDiversionAdHoc: type: boolean description: "Whether or not users with this role are allowed to access the diversion functionality in AdHoc.\n " allowManageTailNumber: type: boolean description: "Whether or not users with this role are allowed to access the Tail Number utility.\n " allowEquipmentSwapUtilityAccess: type: boolean description: "Whether or not users with this role are allowed to access the Equipment Swap utility.\n " allowRZAccess: type: boolean description: "Whether or not users with this role are allowed to create and modify basic reservations with RZ.\n " allowUpdateStandbyPriorityCode: type: boolean description: "Whether or not users with this role are allowed to update the standby priority codes for bookings.\n " allowManageVoucher: type: boolean description: "Whether or not users with this role are allowed to access the Voucher Utility.\n " flightInformationPermissions: description: "Indicates the level of access this role has for the Flight Information API.\n " $ref: '#/components/schemas/AccessControl' allowSegmentsByTime: type: boolean description: "Whether or not users with this role are allowed to search for segments by time.\n " allowBaggageTrackingAccess: type: boolean description: "Allows agents with this role to access the Baggage Tracking utility.\n " enableFlightSearchRestrictionByOrigin: type: boolean description: "Whether or not users with this role are restricted from searching flights based on origin.\n " allowBaggageModeSwitchToIBCMode: type: boolean description: "Whether or not users with this role are allowed to switch default Baggage mode to IBC (Interline Baggage\nCalculator) mode.\n " daysForwardAllowedForSearchingCheckInAndReports: type: string description: "Indicates the number of days after the current date this user can search for Check-In reports.\n " format: duration daysPriorAllowedForSearchingCheckInAndReports: type: string description: "Indicates the number of days prior to the current date this user can search for Check-In reports.\n " format: duration sendAPISReport: type: boolean description: "Whether or not users with this role are allowed to generate and send the APIS (Advance Passenger Information\nSystem) report.\n " watchList: description: "Watch list operations settings.\n " $ref: '#/components/schemas/WatchListSettings' programs: description: "Programs operations settings.\n " $ref: '#/components/schemas/ProgramsSettings' reports: description: "Reports operations settings.\n " $ref: '#/components/schemas/ReportsSettings' DeltaMapperOfPassengerSettings: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: passengerTitle: description: "Passenger title field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerFirstName: description: "Passenger first name field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerMiddleName: description: "Passenger middle name field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerLastName: description: "Passenger last name field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerSuffix: description: "Passenger suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerCustomerNumber: description: "Passenger customer number field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerGender: description: "Passenger gender field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerDateOfBirth: description: "Passenger date of birth field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerNationality: description: "Passenger nationality field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerResidentCountry: description: "Passenger resident country field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantTitle: description: "Infant title field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantFirstName: description: "Infant first name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantMiddleName: description: "Infant middle name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantLastName: description: "Infant last name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantSuffix: description: "Infant suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantGender: description: "Infant gender field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantDateOfBirth: description: "Infant date of birth field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantNationality: description: "Infant nationality field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantResidentCountry: description: "Infant resident country field validation control.\n " $ref: '#/components/schemas/FieldControlType' tbaPassengersAllowed: description: "TBA passenger will allow users to enter passengers with information \"To Be Determined\".\n " $ref: '#/components/schemas/TbaPassengersAllowed' allowCustomerProgram: type: boolean description: "Flag to indicate if passenger customer programs are allowed.\n " allowNameChange: type: boolean description: "Flag to indicate if passenger name changes are allowed.\n " maskedGdprSettings: description: "GDPR related settings that are masked.\n " properties: travelDocumentInformation: type: boolean description: "Flag to indicate if the passenger travel document information is masked.\n " travelDocumentDetails: type: boolean description: "Flag to indicate if the passenger travel document details is masked.\n " otherAirlineFrequentFlyer: type: boolean description: "Flag to indicate if the passenger OA frequent flyer is masked.\n " ssrNotes: type: boolean description: "Flag to indicate if the passenger SSR notes are masked.\n " addressTypes: type: - array - 'null' description: "The list of address types that are masked.\n " items: $ref: '#/components/schemas/ApisAddressStatus' travelNotificationDeliveryAddress: type: boolean description: "Flag to indicate if the passenger travel notification delivery address is masked.\n " IJsonResponseOfCustomerAccountSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CustomerAccountSettings' 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' ServiceBundlesSettings: type: object description: "Defines the settings for service bundles.\n " additionalProperties: false properties: allowRemovalOfCommittedAddOnBundles: type: boolean description: "Indicates if agents are allowed to remove committed add-on bundles.\n " ChannelType: type: integer description: "Defines the available channel types doing invoking the communication with the server.\n \n\n0 = Default\n1 = Direct\n2 = Web\n3 = Gds\n4 = Api\n5 = DigitalApi\n6 = DigitalWeb\n7 = Ndc" x-enumNames: - Default - Direct - Web - Gds - Api - DigitalApi - DigitalWeb - Ndc enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 IJsonResponseOfExternalMessageControls: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ExternalMessageControls' 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' IJsonResponseOfGeneralBookingSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/GeneralBookingSettings' 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' DistributionOption: type: integer description: "This enumeration specifies the distribution methods for sending notifications.\n \n\n0 = None\n1 = Mail\n2 = Email\n3 = Fax\n4 = MailFax\n5 = Airport\n6 = Hold\n7 = Print" x-enumNames: - None - Mail - Email - Fax - MailFax - Airport - Hold - Print enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 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' PaymentSettings: type: object description: "The payment settings.\n " additionalProperties: false properties: defaultCommentForCreditShell: type: - string - 'null' description: "Hold the default comment that will be applied for a credit shell payment.\n " webDeclinedPaymentHoldPeriod: type: integer description: "Web declined payment hold period.\n " format: int32 directDeclinedPaymentHoldPeriod: type: integer description: "Direct declined payment hold period.\n " format: int32 gdsDeclinedPaymentHoldPeriod: type: integer description: "GDS declined payment hold period.\n " format: int32 apiDeclinedPaymentHoldPeriod: type: integer description: "API declined payment hold period.\n " format: int32 autoCancelChargeBackPaymentHolds: type: boolean description: "Auto cancel charge back payment holds.\n " allowZeroAmountFormOfPayment: type: boolean description: "Allow zero amount form of payment.\n " includeInFirstInstallmentFeeCodes: type: - array - 'null' description: "Include in first installment fee codes.\n " items: type: string retainHoldStatusUntilPaymentAuthorization: type: boolean description: "Retain hold status until payment authorization.\n " validateCurrencyEnforcedAgainstPaymentType: description: "The currency to use when validating a payment.\n " $ref: '#/components/schemas/ValidatePaymentCurrencyType' numberOfDeclinedRefundAndReverseAttempts: type: integer description: "The number of declined refund and reverse attempts allowed.\n " format: int32 IJsonResponseOfGeneralNotificationsSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/GeneralNotificationsSettings' 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' PremiumServicesSettingsv2: type: object description: "Settings for the premium services.\n " additionalProperties: false properties: accessToExternalBaggageSystems: type: boolean description: "The value to indicate if access to external baggage\nsystems is enabled.\n " advancedParentChildTravelAgencyManagement: type: boolean description: "The value to indicate if advanced parent child travel agency\nmanagment is enabled.\n " baggageSelfTagging: type: boolean description: "The value to indicate if baggage self tagging is enabled.\n " loyaltyCustomerAccountView: type: boolean description: "The value to indicate if the loyalty customer account view is enabled.\n " pricingOptimizationServices: type: boolean description: "The value to indicate if pricing optimization services are enabled.\n " secureFlight: type: boolean description: "The value to indicate if secure flight is enabled.\n " allInclusivePricingDisplay: type: boolean description: "The value to indicate if all inclusive pricing display is enabled.\n " numericAddressVerificationService: type: boolean description: "The value to indicate if the numeric address verification service\nis enabled.\n " koreanInteractiveAdvancePassengerProcessing: type: boolean description: "The value to indicate if interactive advance passenger processing\nis enabled for the Korean government.\n " taiwanInteractiveAdvancePassengerProcessing: type: boolean description: "The value to indicate if interactive advance passenger processing\nis enabled for the National Immigration Agency (NIA) of Taiwan.\n " canadaInteractiveAdvancePassengerProcessing: type: boolean description: "The value to indicate if interactive advance passenger processing\nis enabled for the Canada Border Services Agency (CBSA).\n " attributeShopping: type: boolean description: "The value to indicate if attribute shopping is enabled.\n " documentCheckConfiguration: type: boolean description: "The value to indicate if document check configuration is enabled.\n " transmitFareDataToAirlineTariffPublishingCompany: type: boolean description: "The value to indicate if the transmission of fares data to the\nairline tariff publishing company feature is enabled.\n " travelNotifications: type: boolean description: "The value to indicate if travel notifications are enabled.\n " bundles: type: boolean description: "The value to indicate if service bundles are enabled.\n " governmentDataProtectionRequirements: type: boolean description: "The value to indicate if the government data protection requirements\nare enabled.\n " unitedKingdomInteractiveAdvancePassengerProcessing: type: boolean description: "The value to indicate if interactive advance passenger processing\nis enabled for the United Kingdom.\n " doNotPersistExternalPaymentDetails: type: boolean description: "Indicates if the external payment details are allowed to be stored in the system.\n " GeneralNotificationsSettings: type: object description: "Settings for general New Skies notifications.\n " additionalProperties: false properties: enableTicketControlNumberNotifications: type: boolean description: "If set to true, Ticket Control Number (TCN) notifications will be sent to the Sales Data Interchange and\nSkyLedger plug-ins.\n " HighlightOption: type: integer description: "Enumeration representing highlight options\n \n\n0 = None\n1 = Highlight" x-enumNames: - None - Highlight enum: - 0 - 1 IJsonResponseOfServiceBundlesSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ServiceBundlesSettings' 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' IJsonResponseOfCustomerProgramSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CustomerProgramSettings' 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' IJsonResponseOfFinanceSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/FinanceSettings' 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' LoyaltySettings: type: object description: "Loyalty settings\n " additionalProperties: false properties: defaultLoyaltyCustomerProgramCode: type: - string - 'null' description: "The default loyalty customer program code.\n " useCustomerNumberForLoyaltyPayments: type: boolean description: "The flag whether to use customer number for loyalty payments.\n " autoEnrollment: description: "The loyalty auto enrollment, if it is enabled and if so which method is in use.\n " $ref: '#/components/schemas/LoyaltyAutoEnrollment' AllowedFareOverrideType: type: integer description: "Enumeration representing which type of fare overrides are allowed by a role.\n \n\n0 = DiscountedPrice\n1 = PublishedPrice\n2 = All" x-enumNames: - DiscountedPrice - PublishedPrice - All enum: - 0 - 1 - 2 Exception: type: object additionalProperties: false properties: Message: type: string InnerException: $ref: '#/components/schemas/Exception' Source: type: - string - 'null' StackTrace: type: - string - 'null' IJsonResponseOfLogonSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/LogonSettings' 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' CodesSettings: type: object description: "The codes settings.\n " additionalProperties: false properties: allowedPaymentMethodsForFraudPrevention: type: - object - 'null' description: "A dictionary that map payment method codes to a boolean representing whether it is allowed for fraud\nprevention.\n " additionalProperties: type: boolean automaticMoveNestOverbookClasses: type: - array - 'null' description: "A list of classes that automatically move or nest on overbook.\n " items: type: string editableRuleTypes: type: - array - 'null' description: "A list of editable rule types.\n " items: type: string externalPaymentValidationOverrides: type: - object - 'null' description: "A list of external payment codes that allow validation overrides.\n " additionalProperties: type: boolean overrideFeeTypes: type: - array - 'null' description: "A list of fee types that allow overrides. = ['All', 'Tax', 'TravelFee', 'ServiceFee', 'PaymentFee', 'PenaltyFee',\n'SsrFee', 'NonFlightServiceFee', 'UpgradeFee', 'SeatFee', 'BaseFare', 'SpoilageFee', 'NameChangeFee',\n'ConvenienceFee', 'BaggageFee', 'FareSurcharge', 'PromotionDiscount']\n " items: $ref: '#/components/schemas/FeeType' paymentFieldOverrides: type: - object - 'null' description: "A dictionary that map payment codes with a dictionary mapping payment fields to their requirement\nrules.\n " additionalProperties: type: object additionalProperties: $ref: '#/components/schemas/RequiredType' privateTravelQueueCategory: description: "The permissions allowed on the private travel queue category for this role.\n " $ref: '#/components/schemas/QueueCategoriesAccessControl' publicTravelQueueCategory: description: "The permissions allowed on the public travel queue category for this role.\n " $ref: '#/components/schemas/QueueCategoriesAccessControl' refundablePaymentMethodCodes: type: - array - 'null' description: "A list of payment codes that allow refunds.\n " items: type: string spoilFeeTypes: type: - array - 'null' description: "A list of fee types that are Spoilage Fees. = ['All', 'Tax', 'TravelFee', 'ServiceFee', 'PaymentFee', 'PenaltyFee',\n'SsrFee', 'NonFlightServiceFee', 'UpgradeFee', 'SeatFee', 'BaseFare', 'SpoilageFee', 'NameChangeFee',\n'ConvenienceFee', 'BaggageFee', 'FareSurcharge', 'PromotionDiscount']\n " items: $ref: '#/components/schemas/FeeType' classOfServices: type: - array - 'null' description: "A list of allowed classes of service.\n " items: type: string depositPaymentTypes: type: - array - 'null' description: "A list of allowed payment codes that are deposit payment types.\n " items: type: string fareTypes: type: - array - 'null' description: "A list of allowed fare types.\n " items: type: string passengerDiscountCodes: type: - array - 'null' description: "A list of allowed passenger discount codes.\n " items: type: string passengerTypeCodes: type: - array - 'null' description: "A list of allowed passenger types.\n " items: type: string paymentMethodCodes: type: - array - 'null' description: "A list of allowed payment method codes.\n " items: type: string penaltyFeeCodes: type: - array - 'null' description: "A list of penalty fee codes.\n " items: type: string productClasses: type: - array - 'null' description: "A list of allowed product classes.\n " items: type: string queueCategoryCodes: type: - object - 'null' description: "A dictionary that maps queue category codes.\n " additionalProperties: type: integer format: int32 sellSsrCodes: type: - array - 'null' description: "The allowed sell SSR Codes.\n " items: type: string serviceFeeCodes: type: - array - 'null' description: "The allowed service fee codes.\n " items: type: string standbyClassOfServiceCodes: type: - array - 'null' description: "The class of services that are allowed standby.\n " items: type: string stationCategories: type: - array - 'null' description: "The allowed station categories.\n " items: type: string viewableSeatProperties: type: - array - 'null' description: "The list viewable seat properties.\n " items: type: string waiveFeeTypes: type: - array - 'null' description: "The fee types that allow waiving. = ['All', 'Tax', 'TravelFee', 'ServiceFee', 'PaymentFee', 'PenaltyFee', 'SsrFee',\n'NonFlightServiceFee', 'UpgradeFee', 'SeatFee', 'BaseFare', 'SpoilageFee', 'NameChangeFee', 'ConvenienceFee',\n'BaggageFee', 'FareSurcharge', 'PromotionDiscount']\n " items: $ref: '#/components/schemas/FeeType' defaultFareType: type: - string - 'null' description: "The default fare type set in the availability screen.\n " CheckInSettings: type: object description: "The Booking Check-In Settings.\n " additionalProperties: false properties: allowApisCheckIn: description: "Gets or sets the APIS rules for Check-In.\n " $ref: '#/components/schemas/ApisCheckInType' allowIappCheckIn: description: "Gets or sets the IAPP rules for Check-In.\n " $ref: '#/components/schemas/IappCheckInType' domesticBagWeight: description: "Gets or sets the Domestic bag weight rules for Check-In.\n " $ref: '#/components/schemas/BagWeightControl' internationalBagWeight: description: "Gets or sets the International bag weight rules for Check-In.\n " $ref: '#/components/schemas/BagWeightControl' allowAppsCheckIn: type: boolean description: "Gets or sets the flag to allow APPS Checkin.\n " allowAppsOverride: type: boolean description: "Gets or sets the flag to allow APPS override in Check-In.\n " allowBagTagDestinationMismatch: type: boolean description: "Gets or sets the allow bag tag destination mismatch flag for Check-In.\n " allowBagTagReprint: type: boolean description: "Gets or sets the flag to allow reprinting bag tags for Check-In.\n " allowCheckedInPassengerFlightChange: type: boolean description: "Gets or sets the flag that allows checked-in passenger to change flight for Check-In.\n " allowCheckedInPassengerNameChange: type: boolean description: "Gets or sets the flag that allows checked-in passenger to change name for Check-In.\n " allowCheckInOfPassengerWithPendingPayments: type: boolean description: "Gets or sets the flag that allows a passenger with pending payments to check-in.\n " allowCheckInWhenTicketCollected: type: boolean description: "Gets or sets the flag that allows a passenger to check-in when ticket is collected for Check-In.\n " allowETicketCouponStatusOverride: type: boolean description: "Gets or sets the status override flag for allowing an E-Ticket coupon for Check-In.\n " allowGatePassPrinting: type: boolean description: "Gets or sets the flag for allowing the gate info to be printed for Check-In.\n " allowInvalidBookingCheckIn: type: boolean description: "Gets or sets the flag for allowing an invalid booking to be checked-in.\n " allowManualClearance: type: boolean description: "Gets or sets the flag for allowing manual clearance IN OUTAGE MODE for Check-In.\n " allowMidJourneyCheckIn: type: boolean description: "Gets or sets the flag for allowing mid-journey Check-In.\n " allowTbaCheckIn: type: boolean description: "Gets or sets the flag allowing a passenger with the name TBA to be allowed to check-in.\n " ignoreMarketTimeRestrictions: type: boolean description: "Gets or sets the flag allowing to ignore market time restrictions for Check-In.\n " checkedInPassengerFlightChangeOffset: type: - string - 'null' description: "Gets or sets the timespan a checked-in passenger can change flights.\n " format: duration checkedInPassengerNameChangeOffset: type: - string - 'null' description: "Gets or sets the timespan a checked-in passenger can change names.\n " format: duration checkedInCloseOffset: type: - string - 'null' description: "Gets or sets the timespan a passengers opportunity to check-in closes prior to flight.\n " format: duration checkedInOpenOffset: type: - string - 'null' description: "Gets or sets the timespan a passengers opportunity to check-in opens prior to flight.\n " format: duration allowedSsrCodes: type: - array - 'null' description: "Gets or sets a collection of allowed SSR codes for Check-In reference.\n " items: type: string restrictedSsrCodes: type: - array - 'null' description: "Gets or sets a collection of restricted SSR codes for Check-In reference.\n " items: type: string requiredSsrCodes: type: - array - 'null' description: "Gets or sets a collection of required SSR codes for Check-In reference.\n " items: type: string allowManualClearanceInNormalMode: type: boolean description: "Gets or sets the flag for allowing manual clearance IN NORMAL MODE for Check-In.\n " IJsonResponseOfGeneralSystemSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/GeneralSystemSettings' 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' ReportsSettings: type: object description: "Reports Settings sub-group of the Operations Settings (aka Department Control)\n " additionalProperties: false properties: enplanementDeplanement: type: boolean description: "Whether or not users with this role are allowed to generate and view Enplanement and Deplanement reports.\n " manifestConnectionInfo: type: boolean description: "Whether or not users with this role are allowed to generate and view the manifest connection info reports.\n " manifestDetailedInfo: type: boolean description: "Whether or not users with this role are allowed to generate and view Manifest with Detailed Information reports.\n " flightLoad: type: boolean description: "Whether or not users with this role are allowed to generate and view Flight Load reports.\n " checkIn: type: boolean description: "Whether or not users with this role are allowed to generate and view Check-In reports.\n " aircraftZone: type: boolean description: "Whether or not users with this role are allowed to generate and view Aircraft Zone reports.\n " seatAssignment: type: boolean description: "Whether or not users with this role are allowed to generate and view Seat Assignment reports.\n " flightClose: type: boolean description: "Whether or not users with this role are allowed to generate and view Flight Close reports.\n " paymentReceipt: type: boolean description: "Whether or not users with this role are allowed to generate and view Payment Receipt reports.\n " paymentReceiptConfigurations: description: "Payment receipt report configurations.\n " $ref: '#/components/schemas/PaymentReceiptReportConfigurations' checkedBaggage: type: boolean description: "Whether or not users with this role are allowed to generate and view Checked Baggage reports.\n " availability: type: boolean description: "Whether or not users with this role are allowed to generate view Availability reports.\n " bagWeightByLeg: type: boolean description: "Whether or not users with this role are allowed to generate view Bag Weight by Leg reports.\n " selecteesByFlight: type: boolean description: "Whether or not users with this role are allowed to generate and view Flight Manifest reports by Selectee.\n " mealFulfillment: type: boolean description: "Whether or not users with this role are allowed to generate and view Meal Fulfillment reports.\n " flightManifest: type: boolean description: "Whether or not users with this role are allowed to view Flight Manifests\n " flightManifestConfigurations: description: "The search configurations for the Flight Manifest reports.\n " $ref: '#/components/schemas/FlightManifestReportConfigurations' prePostFlightManifest: type: boolean description: "Whether or not users with this role are allowed to generate and view Pre/Post Flight Manifest reports.\n " cabinServiceArea: type: boolean description: "Whether or not users with this role are allowed to generate and view Cabin Service Area reports.\n " displayPNRInCabinServiceAreaAndMealFulfillmentReports: type: boolean description: "Whether or not users with this role are allowed to include the PNR (Passenger Name Record) when the In-Cabin\nService Area and Meal Fulfillment report is generated.\n " DeliveringSystem: type: object description: "The configuration data for the e-ticket point of sale delivering system.\n " additionalProperties: false properties: carrierCode: type: - string - 'null' description: "The airline code of the system that delivers the message.\nCan also be referred to as Company Identifier.\n " companyIdNumber: type: - string - 'null' description: "The company ID number.\n " stationCode: type: - string - 'null' description: "The station code of the delivering system's physical location.\nCan also be referred to as Place Location Identifier or Location Code.\n " PassengerGdprSettings: type: object description: "The GDPR related settings for the passenger role settings.\n " additionalProperties: false properties: travelDocumentInformation: type: boolean description: "Flag to indicate if the passenger travel document information is masked.\n " travelDocumentDetails: type: boolean description: "Flag to indicate if the passenger travel document details is masked.\n " otherAirlineFrequentFlyer: type: boolean description: "Flag to indicate if the passenger OA frequent flyer is masked.\n " ssrNotes: type: boolean description: "Flag to indicate if the passenger SSR notes are masked.\n " addressTypes: type: - array - 'null' description: "The list of address types that are masked.\n " items: $ref: '#/components/schemas/ApisAddressStatus' travelNotificationDeliveryAddress: type: boolean description: "Flag to indicate if the passenger travel notification delivery address is masked.\n " 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 ValidatePaymentCurrencyType: type: integer description: "Enumeration with the options for which currency to use when validating a payment type\n \n\n0 = BookingCurrency\n1 = PaymentCurrency" x-enumNames: - BookingCurrency - PaymentCurrency enum: - 0 - 1 MoveFlightCode: type: integer description: "Defines the move flight\n \n\n0 = NotAllowed\n1 = AllowedOnInventory\n2 = Allowed" x-enumNames: - NotAllowed - AllowedOnInventory - Allowed enum: - 0 - 1 - 2 IJsonResponseOfOrganizationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/OrganizationSettings' 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' BaseFareRoundingUnit: type: object description: "The currency code and rounding unit configuration for e-tickets.\n " additionalProperties: false properties: currencyCode: type: - string - 'null' description: "The currency code.\n " roundingUnit: type: - string - 'null' description: "The rounding unit.\n " LowFareCacheOption: type: integer description: "Determines the low fare caching options.\n \n\n0 = AlwaysUseCache\n1 = BypassCacheOnRequest\n2 = NeverUseCache" x-enumNames: - AlwaysUseCache - BypassCacheOnRequest - NeverUseCache enum: - 0 - 1 - 2 BagWeightControl: type: integer description: "Enumeration for Bag weight rules.\n \n\n0 = WeightNotRequired\n1 = TotalWeightRequired\n2 = IndividualWeightRequired" x-enumNames: - WeightNotRequired - TotalWeightRequired - IndividualWeightRequired enum: - 0 - 1 - 2 FeeSettings: type: object description: "The booking fee settings.\n " additionalProperties: false properties: allowNegativeFees: type: boolean description: "Gets or sets the flag allowing negative fees.\n " allowOtherCurrencies: type: boolean description: "Gets or sets the flag allowing other currency fees.\n " cancelGracePeriod: type: - string - 'null' description: "Gets or sets the timeframe for the cancel grace period.\n " format: duration displayTaxesForFeesOnBreakdown: type: boolean description: "Gets or sets the flag that allows displaying taxes for fees on the breakdown.\n " feeDescription: description: "Gets or sets the restriction for fee description fields.\n " $ref: '#/components/schemas/FieldControlType' allowFeesWithPoints: type: boolean description: "Gets or sets the flag that allows selling of fees with points.\n " doNotAllowFeesToBeDeleted: type: boolean description: "Gets or sets the flag that restricts the deletion of fees.\n " ETicketPointOfSale: type: object description: "The configuration data for e-ticketing point of sale.\n " additionalProperties: false properties: deliveringSystem: description: "The delivering system.\n " $ref: '#/components/schemas/DeliveringSystem' originator: description: "The originator details.\n " $ref: '#/components/schemas/OriginatorDetails' system: description: "The system details.\n " $ref: '#/components/schemas/SystemDetails' IappCheckInType: type: integer description: "Enumeration of IAPP Check-in rules.\n \n\n0 = NotAllowed\n1 = AllowedWithVerifiedDocument\n2 = AllowedWithDocument\n3 = AllowedWithoutVerifiedDocument" x-enumNames: - NotAllowed - AllowedWithVerifiedDocument - AllowedWithDocument - AllowedWithoutVerifiedDocument enum: - 0 - 1 - 2 - 3 TravelerNotificationSettings: type: object description: "Settings for traveler notification.\n " additionalProperties: false properties: allowBookingLevelRequest: type: boolean description: "Indicates if the booking-level setting on notification delivery methods is enabled.\nIf enabled, the passengers can request notifications (via email or SMS) without having a New Skies customer\nprofile.\n " FinanceSettingsData: type: object description: "System configuration - finance data or container.\n " additionalProperties: false properties: manageAccounts: description: "Gets or Sets the level of access allowed on managing accounts.\n " $ref: '#/components/schemas/AccessControl' manageCreditTypes: description: "Gets or Sets the level of access allowed on managing credit types.\n " $ref: '#/components/schemas/AccessControl' manageCurrency: description: "Gets or Sets the level of access allowed on managing currency.\n " $ref: '#/components/schemas/AccessControl' manageFareDiscountCodes: description: "Gets or Sets the level of access allowed on managing fare discount codes.\n " $ref: '#/components/schemas/AccessControl' manageFareSurcharges: description: "Gets or Sets the level of access allowed on managing fare surcharges\n " $ref: '#/components/schemas/AccessControl' managePaymentTypes: description: "Gets or Sets the level of access allowed on managing payment types.\n " $ref: '#/components/schemas/AccessControl' managePromotionCodes: description: "Gets or Sets the level of access allowed on managing promotion codes.\n " $ref: '#/components/schemas/AccessControl' manageTaxesAndFees: description: "Gets or Sets the level of access allowed on managing taxes and fees.\n " $ref: '#/components/schemas/AccessControl' allowAgentToImportFeeVariations: type: boolean description: "Gets or Sets the level of access allowed in allowing agent to import fee variations .\n " manageVouchers: description: "Gets or Sets the level of access allowed on managing vouchers.\n " $ref: '#/components/schemas/AccessControl' allowAccountReconciliation: type: boolean description: "Gets or Sets the level of access allowed in allowing agent to access Account Reconciliation.\n " allowBalanceAndCreditLimitUpdate: type: boolean description: "Gets or Sets the level of access allowed in allowing agent to access Balance And Credit Limit Update.\n " allowAccountStatementAdjustment: type: boolean description: "Gets or Sets the level of access allowed in allowing agent to access Statement Adjustment.\n " IJsonResponseOfFlightSearchSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/FlightSearchSettings' 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' ItinerarySettings: type: object description: "Settings for the premium services.\n " additionalProperties: false properties: allowDivideEmailUpdate: type: boolean description: "Indicates if the user is allowed to specify/update the contact email of both the original\nand the new bookings during the divide process.\n " sendItineraryOnHeldBookings: type: boolean description: "Indicates if an itinerary notification will be sent for a booking with a hold.\n " sendItineraryOnHeldCancelledBookings: type: boolean description: "Indicates if an itinerary notification will be sent for a held-cancelled booking.\n " sendItineraryOnPartiallyPaidBookings: type: boolean description: "Indicates if an itinerary notification will be sent for a partially paid booking.\n " NotificationPreference: type: integer description: "Describes types of notifications the user would prefer.\n \n\n0 = None\n1 = Promotional" x-enumNames: - None - Promotional enum: - 0 - 1 TimeDisplay: type: integer description: "Enumeration for the different time display options.\n \n\n0 = Default\n1 = AmPm\n2 = TwentyFourHour" x-enumNames: - Default - AmPm - TwentyFourHour enum: - 0 - 1 - 2 RequiredType: type: integer description: "This enum represents the state of a payment field.\n \n\n0 = Required\n1 = Optional\n2 = NotAllowed" x-enumNames: - Required - Optional - NotAllowed enum: - 0 - 1 - 2 IJsonResponseOfReserveFlightsSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ReserveFlightsSettings' 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' MessageDelivery: type: object description: "The configuration data for e-ticketing message delivery.\n " additionalProperties: false properties: applicationReference: type: - string - 'null' description: "The application reference.\n " routeIp: type: - string - 'null' description: "The IP address and port number where the message will be routed.\n " layer5ReferenceCode: type: - string - 'null' description: "The code used to determine the target system where the message will be sent.\n " interchangeHeader: description: "The message header data.\n " $ref: '#/components/schemas/InterchangeHeader' IJsonResponseOfLoyaltySettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/LoyaltySettings' 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' SessionSettings: type: object description: "The session settings.\n " additionalProperties: false properties: sessionTimeOutInterval: type: - string - 'null' description: "The timeout interval for the session.\n " format: duration allowApiChannelLogon: type: boolean description: "The flag for allowing the API channel logon.\n " allowDirectChannelLogon: type: boolean description: "The flag for allowing the Direct channel logon.\n " allowGdsChannelLogon: type: boolean description: "The flag for allowing the GDS channel logon.\n " allowWebChannelLogon: type: boolean description: "The flag for allowing the Web channel logon.\n " IJsonResponseOfContactSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ContactSettings' 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' IJsonResponseOfOperationsSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/OperationsSettings' 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' ManifestViewDateType: type: integer description: "This enumeration represents the manifest view date type.\n \n\n0 = BookingDate\n1 = SoldDate" x-enumNames: - BookingDate - SoldDate enum: - 0 - 1 ETicketConfiguration: type: object description: "The e-ticket-related configuration data.\n " additionalProperties: false properties: active: type: boolean description: "Indicates if the configuration is active or inactive.\n " code: type: - string - 'null' description: "The configuration code.\n " description: type: - string - 'null' description: "The configuration description.\n " messageContent: description: "The message content configuration data.\n " $ref: '#/components/schemas/MessageContent' messageDelivery: description: "The message delivery configuration data.\n " $ref: '#/components/schemas/MessageDelivery' issuingCarrier: type: - string - 'null' description: "The issuing carrier of the e-ticket.\n " eTicketPointOfSale: description: "The point of sale configuration data.\n " $ref: '#/components/schemas/ETicketPointOfSale' ExternalMessageControls: type: object description: "Settings for external messaging.\n " additionalProperties: false properties: carrierCodes: type: - array - 'null' description: "List of carrier codes from the e-ticket database.\n " items: type: string IJsonResponseOfPassengerSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerSettings' 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' CustomerAccessControl: type: integer description: "Enumeration for customer access control.\n \n\n0 = View\n1 = CreateAndChange" x-enumNames: - View - CreateAndChange enum: - 0 - 1 EdifactVersion: type: integer description: "Defines the list of supported EDIFACT version for ticketing requests.\n \n\n0 = Unknown\n1 = Version032\n2 = Version081" x-enumNames: - Unknown - Version032 - Version081 enum: - 0 - 1 - 2 PhoneNumberValidationSettings: type: object description: "Represents the settings for phone number validation.\n " additionalProperties: false properties: displayText: type: - string - 'null' description: "The display text that describes the required format.\nExample: (###) ###-####\n " validationType: description: "The validation method used.\n " $ref: '#/components/schemas/PhoneNumberValidationType' validationRequirements: type: - array - 'null' description: "The list of values that determines if a phone number is a valid.\n " items: type: string EndorsementComment: type: object description: "The configuration data for generating endorsement comment.\n " additionalProperties: false properties: voluntaryReissueComment: type: - string - 'null' description: "The issue (EDIFACT #130) and reissue (EDIFACT #134) ticketing message in the IFT 4:10 segment when e-tickets\nare issued and/or reissued for voluntary transactions.\n " voluntaryEndorsementRuleSet: type: - string - 'null' description: "The outbound rule set that will be evaluated to generate the endorsement comment.\n " involuntaryReissueComment: type: - string - 'null' description: "The reissue (EDIFACT #134) ticketing message in the IFT 4:10 segment when e-tickets are reissued for involuntary\ntransactions.\n " BookingAccessControl: type: integer description: "Enumeration representing access rights to booking operations. Each value has access to all the values below it.\n \n\n0 = None\n1 = ScheduleOnly\n2 = Availability\n3 = View\n4 = ModifyNoCommit\n5 = Create\n6 = Change\n7 = CreateAndChange" x-enumNames: - None - ScheduleOnly - Availability - View - ModifyNoCommit - Create - Change - CreateAndChange enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 IJsonResponseOfFeeSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/FeeSettings' 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' IJsonResponseOfGeneralSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/GeneralSettings' 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' IJsonResponseOfTravelerNotificationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/TravelerNotificationSettings' 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' OrganizationSettings: type: object description: "Settings for the organization.\n " additionalProperties: false properties: companyTimeZone: type: - string - 'null' description: "The time zone that the airline headquarters is located in.\n " AccessControl: type: integer description: "Defines the user permission levels for managing various operations.\n \n\n0 = None\n1 = Read\n2 = Create\n3 = Update\n4 = Delete\n5 = ReadUpdate\n6 = CreateReadUpdate\n7 = All" x-enumNames: - None - Read - Create - Update - Delete - ReadUpdate - CreateReadUpdate - All enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 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 GeneralBookingSettings: type: object description: "Settings for the general booking settings that are not role specific.\n " additionalProperties: false properties: maximumAgeForInfantInLap: type: integer description: "The maximum age (in months) for the infant-in-lap.\n " format: int32 useDirectCurrencyConversion: type: boolean description: "If true, the direct currency conversion is being used instead to the default inverse calculation.\n " clearInfantDetailsWhenInfantInLapIsDeleted: type: boolean description: "If true, the infant details are cleared when an infant in lap is deleted from a passenger.\n " mixedClassRouteFaresEnabled: type: boolean description: "If true, the RBD functionality is enabled in the booking flow.\n " sumOfSectorFaresEnabled: type: boolean description: "If true, the the sum-of-sectors fares are enabled for the current environment.\n " sumOfSectorProductClassPreCompression: type: boolean description: "If true, the the sum-of-sectors faring logic will pre-compress the set of available fares for\neach segment by product class prior to considering all possible combinations of those fares\nagainst the journey.\n " sellSeatSsrBeforeAssignment: type: boolean description: "If true, a seat dependent ssr can be sold before a seat assignment is made.\n " applyAllUpPricingGlobally: type: boolean description: "If true, this is equivalent to setting the 'Include sales tax and travel fees to the\nfare price at availability' setting on all markets. The user's role setting may still\noverride this. This may also be overridden on a per-request basis in the availability\nrequest.\n " repriceWhenCustomerProgramIsChanged: type: boolean description: "If true, changing a passenger's customer program will trigger an immediate re-price step\neven if no other passenger details were changed. Changing other pricing-sensitive passenger\ncriteria such as the passenger's type code or discount code will always trigger an immediate\nre-price step regardless of this setting.\n " recalculateHoldWithBookingChanges: type: boolean description: "If true, the hold time will be restarted (i.e. reset) when the first un-flown host segment/journey\nis modified in the booking.\n " preventCommitBookingWithCancelledInventory: type: boolean description: "If true, a booking commit will not be allowed for a booking with cancelled inventory.\n " defaultCarrierCode: type: - string - 'null' description: "The default carrier code for the current environment.\n " defaultBookingSubQueueCode: type: - string - 'null' description: "The default booking sub-queue code for the current environment.\n " maximumNumberOfMarkets: type: integer description: "The maximum number of city pairs or journeys that will be supported during a search\n(multi-city shopping mode).\n " format: int32 interlineHoldBeforeDeparture: type: integer description: "The hold time in minutes when host flights are booked by external source in conjunction with\nother airline (OA) flights.\n " format: int32 warningTimeBeforeHoldCancel: type: integer description: "Indicates how long in hours before a hold expires that a notification will be sent.\n " format: int32 interlineConnectionPartners: type: - string - 'null' description: "Indicates the carrier codes of interline partners that can form an interline connection\nin a booking.\n " applyFareForInLapInfantWithPassengerType: type: - string - 'null' description: "If this value is empty, an ssr fee will be added for an infant in lap. If this has a valid\npassenger type code, a fare for the in-lap infant will be added using the specified passenger\ntype code. Note that when this is set, the value of TaxInfantSSRAsFareWithPassengerType is\nno longer used.\n " validateMaximumAgeBy: type: - string - 'null' description: "Indicates whether to validate the maximum age by booking date or on the first non-passive segment on the booking\n " validateMinimumAgeBy: type: - string - 'null' description: "Indicates whether to validate the minimum age by the first or last non-passive segment on the booking.\n " indiaGstRegistrationContactType: type: - string - 'null' description: "The contact type to use for India GST registration details.\n " enforceStandardGroupBooking: type: boolean description: "Indicates if standard group bookings are enforced.\n " storeConfirmingWaivedFees: type: boolean description: "Indicates if waived fees in the confirming state are kept as part of the booking data when being overridden.\n " personallyIdentifiableInformationMasking: type: boolean description: "Indicates if personally identifiable information masking is enabled.\n " lowFareCacheMode: type: - string - 'null' description: "The low fare cache mode settings.\n " retrieveFareInformationFromGeneralReferenceManagement: type: boolean description: "Indicates if fare rule information should be retrieved from the general reference management or from the category\n50 rule information supplied to the fare.\n " enableGenderNeutral: type: boolean description: "Indicates if the support for non-binary genders is enabled.\n " storeDeletedManuallyAddedFees: type: boolean description: "If enabled, manually-added fees that have been deleted by agents will be overridden to zero with an\nindicator/ChargeDetail of \"Fee DL\" instead of being deleted.\nThe setting StoreConfirmingWaivedFees must be set to true in order for this setting to take effect.\n " invalidNameCharacters: type: - string - 'null' description: "The characters that are considered invalid for passenger and contact name fields.\n " DeltaMapperOfFlightSearchSettings: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: bookingMaxPassengers: type: integer description: "The maximum number of passengers allowed on a single booking.\n " format: int32 allowOpenJaw: type: boolean description: "Flag that indicates if open jaw journeys are allowed.\n " allowPrivateFares: type: boolean description: "Flag that indicates whether private fares are allowed.\n " showExpiredFareDateRange: type: integer description: "The number of days after the fare discontinue date that the agent will be allowed to view the fare.\n " format: int32 maxNumberConnectingFlights: type: integer description: "The maximum number of connections on a journey that will be returned from availability.\n " primarySortKey: description: "The primary sort to be used on availability response.\n " $ref: '#/components/schemas/JourneySortKey' secondarySortKey: description: "The secondary sort to be used on the availability response.\n " $ref: '#/components/schemas/JourneySortKey' maxAvailabilityDateRange: type: integer description: "The maximum number of days between the begin and end date for regular availability.\n " format: int32 maxLowFareDateRange: type: integer description: "The maximum number of days between the begin and end date for low fare availability.\n " format: int32 displayLowerFares: description: "Display setting for low fares (used in change flow).\n " $ref: '#/components/schemas/FareDisplayType' fareClassControl: description: "The fare class filtering when returning journeys during availability.\n " $ref: '#/components/schemas/FareClassControl' allUpPricing: type: boolean description: "The flag indicating whether to allow anticipated sales taxes and travel fees when processing the availability\nrequest.\n " fareSorting: description: "Fare filtering options.\n " $ref: '#/components/schemas/FareSelection' lowFareCacheStatus: description: "The status of the low fare cache.\n " $ref: '#/components/schemas/LowFareCacheOption' sortByInterlineConnections: type: boolean description: "This maps to New Skies' Bias Online Commercial Duplicates.\nIf set to true the flight availability results are sorted by online connections (the same carrier for all legs)\nfollowed by the interline connections (between hosted carriers).\n " GroupAccessControl: type: integer description: "Enumeration that represents the access rights to groups.\n \n\n0 = Agent\n1 = Organization\n2 = OrganizationGroup\n3 = All" x-enumNames: - Agent - Organization - OrganizationGroup - All enum: - 0 - 1 - 2 - 3 CustomerProgramSettings: type: object description: "Customer program settings\n " additionalProperties: false properties: loyaltyMergeEnabled: type: boolean description: "Indicates whether merging loyalty accounts is enabled.\n " MessageContent: type: object description: "The configuration data for e-ticketing message content.\n " additionalProperties: false properties: ticketSettings: description: "The ticket settings.\n " $ref: '#/components/schemas/TicketSettings' couponSettings: description: "The coupon settings.\n " $ref: '#/components/schemas/CouponSettings' applyDualTvlForCodeShareFlights: type: boolean description: "Controls the format of code share flights in e-ticket issue and reissue messages.\n " IJsonResponseOfBookingPaymentCodesSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/BookingPaymentCodesSettings' 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' PassengerSettings: type: object description: "The booking passenger settings.\n " additionalProperties: false properties: passengerTitle: description: "Passenger title field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerFirstName: description: "Passenger first name field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerMiddleName: description: "Passenger middle name field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerLastName: description: "Passenger last name field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerSuffix: description: "Passenger suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerCustomerNumber: description: "Passenger customer number field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerGender: description: "Passenger gender field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerDateOfBirth: description: "Passenger date of birth field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerNationality: description: "Passenger nationality field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerResidentCountry: description: "Passenger resident country field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantTitle: description: "Infant title field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantFirstName: description: "Infant first name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantMiddleName: description: "Infant middle name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantLastName: description: "Infant last name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantSuffix: description: "Infant suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantGender: description: "Infant gender field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantDateOfBirth: description: "Infant date of birth field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantNationality: description: "Infant nationality field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantResidentCountry: description: "Infant resident country field validation control.\n " $ref: '#/components/schemas/FieldControlType' tbaPassengersAllowed: description: "TBA passenger will allow users to enter passengers with information \"To Be Determined\".\n " $ref: '#/components/schemas/TbaPassengersAllowed' allowCustomerProgram: type: boolean description: "Flag to indicate if passenger customer programs are allowed.\n " allowNameChange: type: boolean description: "Flag to indicate if passenger name changes are allowed.\n " maskedGdprSettings: description: "GDPR related settings that are masked.\n " $ref: '#/components/schemas/PassengerGdprSettings' FareDisplayType: type: integer description: "Filter used to determine the display status of fares (used during rebook).\n \n\n0 = HideLowerFares\n1 = ShowAndAllowLowerFares\n2 = ShowButDisableLowerFares" x-enumNames: - HideLowerFares - ShowAndAllowLowerFares - ShowButDisableLowerFares enum: - 0 - 1 - 2 QueueCategoriesAccessControl: type: integer description: "This enumeration represents the permission levels for managing queue categories.\n \n\n0 = None\n1 = View\n2 = All" x-enumNames: - None - View - All enum: - 0 - 1 - 2 BookingPaymentCodesSettings: type: object description: "The booking payments codes settings.\n " additionalProperties: false properties: voucherConfigurationCodes: type: - array - 'null' description: "The collection of allowed voucher configuration codes.\n " items: type: string 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 " ApisCheckInType: type: integer description: "Enumeration of APIS Check-in rules.\n \n\n0 = NotAllowed\n1 = AllowedWithVerifiedDocument\n2 = AllowedWithDocument\n3 = AllowedWithoutVerifiedDocument" x-enumNames: - NotAllowed - AllowedWithVerifiedDocument - AllowedWithDocument - AllowedWithoutVerifiedDocument enum: - 0 - 1 - 2 - 3 WatchListSettings: type: object description: "Watch list settings sub-group of the Operations Settings (aka Department Control)\n " additionalProperties: false properties: allowViewForWatchList: type: boolean description: "Whether or not users with this role are allowed to access the Watch List options to view detailed or clear\npassenger watch list.\n " allowDetailViewForWatchList: type: boolean description: "Whether or not users with this role are allowed a Detailed View of Watch List Matches. This permission requires the\nuser be assigned the AllowViewForWatchList permission.\n " allowClearPassengerFromWatchList: type: boolean description: "Whether or not users with this role are allowed to remove entries from a Watch List. To have this permission, the\nuser must be assigned the AllowDetailViewForWatchList permission.\n " OriginatorDetails: type: object description: "The configuration data for the e-ticket point of sale originator details.\n " additionalProperties: false properties: authorityRequestCode: type: - string - 'null' description: "The authority request code.\n " countryCode: type: - string - 'null' description: "The country code.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " inHouseAuthorityCode: type: - string - 'null' description: "The authority code or reference number assigned to the requester.\n " travelAgentCode: type: - string - 'null' description: "The booking agent IATA number.\n " InterchangeHeader: type: object description: "The configuration data for the message delivery interchange header.\n " additionalProperties: false properties: characterSet: description: "The character set used as delimiter for ticketing requests.\n " $ref: '#/components/schemas/CharacterSet' receiver: description: "The next-hop or receiving system.\n " $ref: '#/components/schemas/InterchangeSystem' sender: description: "The sending system.\n " $ref: '#/components/schemas/InterchangeSystem' version: description: "The EDIFACT version for ticketing requests.\n " $ref: '#/components/schemas/EdifactVersion' RoleCodeQuery: type: object description: "Model for a role code query.\n " additionalProperties: false required: - roleCode properties: roleCode: type: string description: "Gets or sets the role code for this request.\n " maxLength: 4 minLength: 1 SeatAssignmentRole: type: integer description: "The Enumeration indicates the seat assignment permissions for selling.\n \n\n0 = Never\n1 = OnlyOnUnheldBookings\n2 = Always" x-enumNames: - Never - OnlyOnUnheldBookings - Always enum: - 0 - 1 - 2 DeltaMapperOfBookingPaymentSettingsv2: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: allowExternalPaymentChargeBack: type: boolean description: "The flag to allow approved external payment charge back.\n " allowHoldDateOverride: type: boolean description: "The flag to allow overriding the hold dates.\n " allowIgnoreVoucherRestrictions: type: boolean description: "The flag to allow ignoring voucher restrictions.\n " allowVoucherIssuance: type: boolean description: "The flag to allow issuing vouchers.\n " allowManualAuthorization: type: boolean description: "The flag to manually authorize credit cards.\n " allowOverPay: type: boolean description: "The flag to allow overpayment.\n " allowUnderPay: type: boolean description: "The flag to allow underpayment.\n " allowUnvoidVoucher: type: boolean description: "The flag to allow unvoiding vouchers.\n " allowUseOfBinFraudTool: type: boolean description: "The flag to allow use of BIN fraud tool.\n " allowVoidVoucher: type: boolean description: "The flag to allow voided vouchers.\n " enableAutoPaymentVerification: type: boolean description: "The flag to enable auto-payment verification.\n " allowConfirmBookingWithPartialTicketing: type: boolean description: "The flag to allow confirming booking with partial ticketing.\n " allowUnmaskingCreditCardNumber: type: boolean description: "The flag to allow displaying the full credit card number without masking.\n " allowDisplayNoPaymentWarning: type: boolean description: "The flag to allow displaying a no payment warning.\n " requirePassengerOrContactForCreditFile: type: boolean description: "The flag to require passengers or contacts for a credit file.\n " requirePassengerOrContactForCreditShell: type: boolean description: "The flag to require passengers or contacts for a credit shell.\n " requireCommentsForCreditShell: type: boolean description: "The flag to require comments for credit shell.\n " disableAlternateAgAccount: type: boolean description: "The flag to disable alternative AG accounts.\n " creditShellCreditCode: type: - string - 'null' description: "The credit shell credit code.\n " maxInstallmentOverride: type: integer description: "Gets or sets a max number of installment overrides.\n " format: int32 maximum: 999.0 minimum: 0.0 maxPaymentQueries: type: integer description: "The max number of payment queries.\n " format: int32 maximum: 10000.0 minimum: 1.0 secondsTillStartPaymentQuery: type: integer description: "The number of seconds till the payment query starts.\n " format: int32 maximum: 10000.0 minimum: 2.0 secondsTillRepeatPaymentQuery: type: integer description: "The number of seconds till the payment query repeats.\n " format: int32 maximum: 10000.0 minimum: 3.0 holdsDaysBeforeDeparture: type: - string - 'null' description: "The duration for a hold before booking date.\n " format: duration holdsDaysAfterDeparture: type: - string - 'null' description: "The duration for a hold after booking date.\n " format: duration allowPendingCustomerActionAuthorization: type: boolean description: "The flag to allow authorization of a pending customer action payment.\n " allowManualAuthorizationOfPendingPaymentWithoutValidation: type: boolean description: "Indicates whether the user is allowed to approve payments\nwith Pending status.\n " maskPaymentFields: type: boolean description: "Mask the payment fields.\n " allowManualAuthorizationOfPaymentStatuses: type: - array - 'null' description: "The collection of payment status that can be manually authorized.\n " items: $ref: '#/components/schemas/BookingPaymentStatus' displayVoucherNumber: type: boolean description: "Display the voucher reference number.\n " allowOverPayWithVoucherPayment: type: - boolean - 'null' description: "Whether to allow overpayment with the voucher payment method.\n " allowVoucherOwnerUpdate: type: - boolean - 'null' description: "Indicates whether the user is allowed to update the voucher owner.\n " ViewManifestControl: type: integer description: "Desfines the view manifest control options.\n \n\n0 = None\n1 = StandbyOnly\n2 = Full" x-enumNames: - None - StandbyOnly - Full enum: - 0 - 1 - 2 IJsonResponseOfKioskSettings: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/KioskSettings' errors: type: - array - 'null' items: $ref: '#/components/schemas/ErrorResponse_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/Message_2' DeviceProperty: type: object additionalProperties: false required: - key - type - value properties: key: type: string minLength: 1 type: $ref: '#/components/schemas/DevicePropertyType' value: type: string minLength: 1 WeightType: type: integer description: 'Specifies the weight unit of measure, either Pounds or Kilograms. 1 = Pounds 2 = Kilograms' x-enumNames: - Pounds - Kilograms enum: - 1 - 2 BoardingScanRegularExpressionCaptureGroupName: type: integer description: '0 = Unknown 1 = CarrierCode 2 = FlightNumber 3 = OpSuffix 4 = Origin 5 = BoardingSequence 6 = UnitDesignator 7 = CurrentDate 8 = DepartureDayOfMonth 9 = DepartureDayOfYear 10 = LastName 11 = FirstName 12 = RecordLocator 13 = PassengerId 14 = SegmentCount 15 = MobileBarcodeDesignator 16 = Segment1 17 = Segment1Origin 18 = Segment1Destination 19 = Segment1CarrierCode 20 = Segment1FlightNumber 21 = Segment1OpSuffix 22 = Segment1DepartureDayOfYear 23 = Segment1UnitDesignator 24 = Segment1BoardingSequence 25 = Segment2 26 = Segment2Origin 27 = Segment2Destination 28 = Segment2CarrierCode 29 = Segment2FlightNumber 30 = Segment2OpSuffix 31 = Segment2DepartureDayOfYear 32 = Segment2UnitDesignator 33 = Segment2BoardingSequence 34 = Segment3 35 = Segment3Origin 36 = Segment3Destination 37 = Segment3CarrierCode 38 = Segment3FlightNumber 39 = Segment3OpSuffix 40 = Segment3DepartureDayOfYear 41 = Segment3UnitDesignator 42 = Segment3BoardingSequence 43 = Segment4 44 = Segment4Origin 45 = Segment4Destination 46 = Segment4CarrierCode 47 = Segment4FlightNumber 48 = Segment4OpSuffix 49 = Segment4DepartureDayOfYear 50 = Segment4UnitDesignator 51 = Segment4BoardingSequence' x-enumNames: - Unknown - CarrierCode - FlightNumber - OpSuffix - Origin - BoardingSequence - UnitDesignator - CurrentDate - DepartureDayOfMonth - DepartureDayOfYear - LastName - FirstName - RecordLocator - PassengerId - SegmentCount - MobileBarcodeDesignator - Segment1 - Segment1Origin - Segment1Destination - Segment1CarrierCode - Segment1FlightNumber - Segment1OpSuffix - Segment1DepartureDayOfYear - Segment1UnitDesignator - Segment1BoardingSequence - Segment2 - Segment2Origin - Segment2Destination - Segment2CarrierCode - Segment2FlightNumber - Segment2OpSuffix - Segment2DepartureDayOfYear - Segment2UnitDesignator - Segment2BoardingSequence - Segment3 - Segment3Origin - Segment3Destination - Segment3CarrierCode - Segment3FlightNumber - Segment3OpSuffix - Segment3DepartureDayOfYear - Segment3UnitDesignator - Segment3BoardingSequence - Segment4 - Segment4Origin - Segment4Destination - Segment4CarrierCode - Segment4FlightNumber - Segment4OpSuffix - Segment4DepartureDayOfYear - Segment4UnitDesignator - Segment4BoardingSequence enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 IJsonResponseOfString: type: object additionalProperties: false properties: data: type: - string - 'null' errors: type: - array - 'null' items: $ref: '#/components/schemas/ErrorResponse_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/Message_2' DevicePropertyType: type: integer description: 'Defines the different types of properties that can be associated with an external device. 0 = Unknown 1 = System 2 = User 3 = Permanent' x-enumNames: - Unknown - System - User - Permanent enum: - 0 - 1 - 2 - 3 BoardingWithoutSeatRestrictionLevel: type: integer description: '0 = Restrict 1 = AllowManualOnly 2 = Allow' x-enumNames: - Restrict - AllowManualOnly - Allow enum: - 0 - 1 - 2 ManifestPassengerSortType: type: integer description: '0 = ApisStatus 1 = AppsStatus 2 = BoardingSequenceNumber 3 = BookingStatus 4 = ChangeCabin 5 = CustomerProgramLevel 6 = CustomerRecognitionLevel 7 = DownlineDepartureDateTime 8 = DownlineFlight 9 = FareClass 10 = FinalDestination 11 = InboundArrivalDateTime 12 = InboundFlight 13 = LiftStatus 14 = PassengerName 15 = PremiumFare 16 = Priority 17 = RecordLocator 18 = SeatAssignment 19 = Ssr 20 = StandbyOnloadOrder 21 = StandbyPriorityCode 22 = TicketTypeIndicator 23 = TravelClass' x-enumNames: - ApisStatus - AppsStatus - BoardingSequenceNumber - BookingStatus - ChangeCabin - CustomerProgramLevel - CustomerRecognitionLevel - DownlineDepartureDateTime - DownlineFlight - FareClass - FinalDestination - InboundArrivalDateTime - InboundFlight - LiftStatus - PassengerName - PremiumFare - Priority - RecordLocator - SeatAssignment - Ssr - StandbyOnloadOrder - StandbyPriorityCode - TicketTypeIndicator - TravelClass enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 CheckinSettingsV2: type: object additionalProperties: false properties: allowWaiveSeatFees: type: boolean changeFeeCommentRequirementLevel: $ref: '#/components/schemas/ChangeFeeCommentRequirementLevel' changeFeeReasonDetails: type: - array - 'null' items: $ref: '#/components/schemas/ChangeFeeReasonDetails' checkinGeneralRequirementTypeDetails: type: - array - 'null' items: $ref: '#/components/schemas/CheckinGeneralRequirementTypeDetails' checkinSecurityRequirementTypeDetails: type: - array - 'null' items: $ref: '#/components/schemas/CheckinSecurityRequirementTypeDetails' defaultBaggageType: type: - string - 'null' domesticMaxBagWeightLimit: type: number format: decimal internationalMaxBagWeightLimit: type: number format: decimal bagWeightsUnitOfMeasure: description: 'This should be named MaxBagWeightLimitsUnitOfMeasure, as it applies only to domesticMaxBagWeightLimit and internationalMaxBagWeightLimit.' $ref: '#/components/schemas/WeightType' pairedSsrConfirmationList: type: - array - 'null' items: $ref: '#/components/schemas/PairedSsrConfirmation' validateDuplicateDocumentWithinManifest: type: boolean maxPassengerBaggage: type: integer premiumFares: type: - array - 'null' items: type: string PrinterRequest: type: object additionalProperties: false required: - printerKey properties: printerKey: type: string minLength: 1 properties: type: - array - 'null' items: $ref: '#/components/schemas/DeviceProperty' usages: type: - array - 'null' items: type: string ChangeFeeCommentRequirementLevel: type: integer description: '0 = Restricted 1 = Optional 2 = Mandatory' x-enumNames: - Restricted - Optional - Mandatory enum: - 0 - 1 - 2 MessageStatus_2: type: integer description: '0 = General 1 = Warning 2 = Critical' x-enumNames: - General - Warning - Critical enum: - 0 - 1 - 2 IJsonResponseOfReportsSettings: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/ReportsSettings_2' errors: type: - array - 'null' items: $ref: '#/components/schemas/ErrorResponse_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/Message_2' DepartureSettings: type: object additionalProperties: false properties: boardingWithBalanceDueRestrictionLevel: description: Indicates whether to restrict, warn, or allow passengers with a balance due at boarding. $ref: '#/components/schemas/RestrictionLevel' boardingWithoutSeatRestrictionLevel: description: 'Indicates whether to restrict, allow only for manual boarding, or allow passengers who don''t have a seat assignment at boarding.' $ref: '#/components/schemas/BoardingWithoutSeatRestrictionLevel' departureTimeApproachBarCriticalMark: type: integer description: Number of minutes before departure time that the boarding bar will turn red. departureTimeApproachBarWarningMark: type: integer description: Number of minutes before departure time that the boarding bar will turn yellow. manifestFilterOptions: type: - array - 'null' description: Ordered list of manifest filters to display. items: $ref: '#/components/schemas/ManifestFilterOptions' ssrsForManifestFilterWithSpecificSsr: type: - array - 'null' description: List of SSR codes used by the manifest filter WithSpecificSsr (AKA Passenger Information List or PIL). items: type: string manifestSortOptions: type: - array - 'null' description: Ordered list of manifest sort types to display. items: $ref: '#/components/schemas/ManifestSortOptions' requireAcknowledgeOnBoardingWithWarning: type: boolean description: Indicates whether an acknowledgment is required when there is a warning during boarding. seatPropertiesWithWarnings: type: - array - 'null' description: List of seat properties that should trigger a warning after successful boarding. items: type: string showPaperTicketWarning: type: boolean description: 'Indicates whether to dispaly a warning at boarding when a passenger has paper tickets that need to be pulled.' ssrCodesWithWarnings: type: - array - 'null' description: List of SSR codes that should trigger a warning after successful boarding. items: type: string boardingScanRegularExpressions: type: - array - 'null' description: "List of regular expressions used to parse boarding scan data. \nThere is 1 regex in the list per boarding scan type. \nSee ApiDepartureSettings.xml for supported scan types and their respective regular expressions. \nBelow are the named groups that may be present after a successful regex match. \nIf a named group is not present upon a successful regex match, then it is not supported for the matching scan type\n\nBOARDING PASS SHORT SCANS\n----------------------------------------------------------------------------------------------------\nScanTYpes:\n \n 1. BoardingPassShort3\n 2. BoardingPassShort3WithOpSuffix\n 3. BoardingPassOffline3\n 4. BoardingPassShort4WithOpSuffix\n 5. BoardingPassShort4\n 6. BoardingPassOffline4\n 7. BoardingPassShort2WithOpSuffix\n 8. BoardingPassShort2\n 9. BoardingPassOffline2\n 10. BoardingPassShort1WithOpSuffix\n 11. BoardingPassShort1\n 12. BoardingPassOffline1\n\nSupported group names:\n\n CarrierCode: Contains the carrier code\n FlightNumber: Contains the flight number,\n OpSuffix: Contains the OpSuffix character,\n Origin: Contains the origin station code,\n BoardingSequence: Contains the boarding sequence number,\n UnitDesignator: Contains the unit designator code (seat),\n DepartureDayOfMonth: Contains the month and year of the flight. Format: mmdd,\n DepartureDayOfYear: Contains the day of year of the departure date. Format: ddd\n \n\nBOARDING PASS LONG SCANS\n----------------------------------------------------------------------------------------------------\nScanTYpes:\n \n 1. BoardingPassLong1Segment\n 2. BoardingPassLong2Segment\n 3. BoardingPassLong3Segment\n 4. BoardingPassLong4Segment\n \nSupported group names:\n\n LastName: Contains the passenger's last name,\n FirstName: Contains the passenger's first name,\n RecordLocator: Contains the PNR of the passenger's booking,\n SegmentCount: Contians the number of segments present in the scan (if the scan is of type BoardingPassLong)\n \n MobileBarcodeDesignator: Contains the character designating that the scan is from a mobile barcode (if this group is not present, it is not a mobile barcode scan)\n \n Segment1: The scan data associated with the first segment in the scan,\n Segment1Origin: Contains the first segment's origin station code \n Segment1Destination Contains the first segment's destination station code \n Segment1CarrierCode: Contains the first segment's carrier code \n Segment1FlightNumber: Contains the first segment's flight number \n Segment1OpSuffix: Contains the first segment's op suffix character \n Segment1DepartureDayOfYear: Contains the first segment's departure day of year format: ddd\n Segment1UnitDesignator: Contains the first segment's unit designator code (seat) \n Segment1BoardingSequence Contains the first segment's boarding sequence number \n \n Segment2: The scan data associated with the second segment in the scan,\n Segment2Origin: Contains the second segment's origin station code \n Segment2Destination Contains the second segment's destination station code \n Segment2CarrierCode: Contains the second segment's carrier code \n Segment2FlightNumber: Contains the second segment's flight number \n Segment2OpSuffix: Contains the second segment's op suffix character \n Segment2DepartureDayOfYear: Contains the second segment's departure day of year format: ddd \n Segment2UnitDesignator: Contains the second segment's unit designator code (seat) \n Segment2BoardingSequence Contains the second segment's boarding sequence number \n \n Segment3: The scan data associated with the third segment in the scan,\n Segment3Origin: Contains the third segment's origin station code \n Segment3Destination Contains the third segment's destination station code \n Segment3CarrierCode: Contains the third segment's carrier code \n Segment3FlightNumber: Contains the third segment's flight number \n Segment3OpSuffix: Contains the third segment's op suffix character \n Segment3DepartureDayOfYear: Contains the third segment's departure day of year format: ddd \n Segment3UnitDesignator: Contains the third segment's unit designator code (seat) \n Segment3BoardingSequence Contains the third segment's boarding sequence number \n \n Segment4: The scan data associated with the fourth segment in the scan,\n Segment4Origin: Contains the fourth segment's origin station code \n Segment4Destination Contains the fourth segment's destination station code \n Segment4CarrierCode: Contains the fourth segment's carrier code \n Segment4FlightNumber: Contains the fourth segment's flight number \n Segment4OpSuffix: Contains the fourth segment's op suffix character \n Segment4DepartureDayOfYear: Contains the fourth segment's departure day of year format: ddd\n Segment4UnitDesignator: Contains the fourth segment's unit designator code (seat) \n Segment4BoardingSequence Contains the fourth segment's boarding sequence number \n \n\nBIOMETRIC SCANS\n----------------------------------------------------------------------------------------------------\nScanTYpes:\n \n Biometric1\n Biometric2\n \nSupported group names:\n\n RecordLocator: Contains the PNR of the passenger's booking\n PassengerId: Contains the passenger's id number\n CarrierCode: Contains the carrier code\n FlightNumber: Contains the flight number\n OpSuffix: Contains the op suffix character\n CurrentDate: Contains the day and month of current date. Format: ddMMM\n DepartureDayOfYear: Contains the day of year of the departure date. Format: ddd" items: $ref: '#/components/schemas/BoardingScanRegularExpression' bookingReseatingQueueCodes: type: - array - 'null' description: List of booking reseating queue codes. items: type: string uncheckDownlineSegmentsDuringDepartureUncheck: type: boolean description: Indicates whether downline segments will be unchecked when a passenger is unchecked in departure. boardingTimeOffsetDomestic: type: integer boardingTimeOffsetInternational: type: integer autoBoardAllCheckedInPassengers: type: boolean convertHoldToConfirmed: type: boolean deleteStandByPassengers: type: boolean apisDefaultFaxNumber: type: - string - 'null' apisDefaultPhoneNumber: type: - string - 'null' apisPreliminaryCarrierCodes: type: - array - 'null' items: type: string ssrCodesToHideInManifestSummary: type: - array - 'null' items: type: string allowForceFlightVerify: type: boolean DeviceManagerSystemType: type: integer description: '0 = Native 1 = PrintToFile 2 = LocalPrinters 3 = Arinc 4 = Cupps 5 = LhsCfdm 6 = Resa 7 = Sita 8 = Ultra 9 = Simulators' x-enumNames: - Native - PrintToFile - LocalPrinters - Arinc - Cupps - LhsCfdm - Resa - Sita - Ultra - Simulators enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 ReportsSettings_2: type: object additionalProperties: false properties: allowAircraftZoneReport: type: boolean allowAvailabilityReport: type: boolean allowBagWeightByLegReport: type: boolean allowCabinServiceAreaReport: type: boolean allowCheckedBaggageReport: type: boolean allowCheckInReport: type: boolean allowEnplanementDeplanementReport: type: boolean allowFlightCloseReport: type: boolean allowFlightLoadReport: type: boolean allowFlightManifestReport: type: boolean allowFlightSummaryReport: type: boolean allowManifestReport: type: boolean allowManifestTripDetailReport: type: boolean allowMealFulfillmentReport: type: boolean allowPaymentReceiptReport: type: boolean allowPrePostFlightManifestReport: type: boolean allowSeatAssignmentReport: type: boolean allowSegmentsByTimeReport: type: boolean allowSelecteesByFlightReport: type: boolean flightManifestReportIdentifySelecteePassengers: type: boolean flightManifestReportIdentifyPassengersWithBalanceDue: type: boolean allowBagTagTrackingReport: type: boolean CheckinStep: type: integer description: '0 = None 1 = Security 2 = Seats 3 = Bags 4 = Services 5 = Payments 6 = Finalize' x-enumNames: - None - Security - Seats - Bags - Services - Payments - Finalize enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 ChangeFeeReasonDetails: type: object additionalProperties: false properties: code: type: - string - 'null' description: type: - string - 'null' IJsonResponseOfCheckinSettingsV2: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/CheckinSettingsV2' errors: type: - array - 'null' items: $ref: '#/components/schemas/ErrorResponse_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/Message_2' IJsonResponseOfDepartureSettings: type: object additionalProperties: false properties: data: $ref: '#/components/schemas/DepartureSettings' errors: type: - array - 'null' items: $ref: '#/components/schemas/ErrorResponse_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/Message_2' ManifestSortOptions: type: object additionalProperties: false properties: type: $ref: '#/components/schemas/ManifestPassengerSortType' displayName: type: - string - 'null' showInManifestView: type: boolean showInSeatsManagement: type: boolean CheckinSecurityRequirementType: type: integer description: '0 = Unknown 1 = ClearanceOverrideRequired 2 = GovernmentSecurityNotVerified 3 = GovermentSecurityCheckInNotAllowed 4 = GovernmentSecurityDestinationAddressRequired 5 = GovernmentSecurityCannotCheckInSelectee 6 = GovernmentSecurityRequired 7 = GovernmentSecuritySelecteeCheckInNotAllowed 8 = GovernmentSecurityVerifyId 9 = AppsOverrideRequired 10 = AppsManualBoardingDirectiveRequired 11 = DocCheckComplete' x-enumNames: - Unknown - ClearanceOverrideRequired - GovernmentSecurityNotVerified - GovermentSecurityCheckInNotAllowed - GovernmentSecurityDestinationAddressRequired - GovernmentSecurityCannotCheckInSelectee - GovernmentSecurityRequired - GovernmentSecuritySelecteeCheckInNotAllowed - GovernmentSecurityVerifyId - AppsOverrideRequired - AppsManualBoardingDirectiveRequired - DocCheckComplete enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 RestrictionLevel: type: integer description: '0 = Restrict 1 = Warn 2 = Allow' x-enumNames: - Restrict - Warn - Allow enum: - 0 - 1 - 2 ErrorResponse_2: type: object additionalProperties: false properties: exception: $ref: '#/components/schemas/Exception' rawMessage: type: - string - 'null' code: type: - string - 'null' message: type: - string - 'null' type: type: - string - 'null' number: type: - integer - 'null' format: int32 maximum: 99999.0 minimum: 0.0 details: type: - object - 'null' additionalProperties: type: string ActivityId: type: - string - 'null' ManifestPassengerFilterType: type: integer description: '0 = NonThruConfirmed 1 = NonThruConfirmedCheckedIn 2 = NonThruConfirmedNoShow 3 = NonThruStandby 4 = NonThruStandbyCheckedIn 5 = ThruConfirmed 6 = ThruConfirmedCheckedIn 7 = ThruConfirmedNoShow 8 = ThruStandby 9 = ThruStandbyCheckedIn 10 = CheckedIn 11 = CheckedInBoarded 12 = CheckedInNotBoarded 13 = CheckedInNotBoardedBagChecked 14 = CheckedInNotBoardedBagAdded 16 = All 17 = CheckedInWithoutSeat 18 = Irop 19 = WithoutSeat 20 = WithCabinChange 21 = WithTravelDocument 22 = CheckedInUnfulfilledAppsRequirment 23 = CheckedInUnfulfilledApisRequirment 24 = CheckedInUnfulfilledAqqRequirment 25 = WithExtraSeat 26 = WithInboundConnection 27 = OnLockOrWarningQueue 28 = WithCustomerAccount 29 = WithDownlineFlight 30 = WithManifestComment 31 = WithSsr 32 = WithoutTravelDocument 33 = WithPremiumFare 34 = WithSeat 35 = OnReseatingQueue 36 = WithUnfulfilledDocCheckRequirement 37 = WithTicketTypeIndicator 38 = Selectee 39 = CheckedInWithUnfulfilledDocCheckRequirement 40 = CheckedInWithOverriddenClearance 41 = CheckedInWithAutoAssignedClearance 42 = CheckedInWithOverriddenClearanceNeeded 43 = WithSpecificSsr 44 = BagRemoved 45 = Child 46 = WithInfant 47 = UnhappyWithSeat 48 = NonThruStandbyNotCheckedIn 49 = BagAdded 50 = BagChecked' x-enumNames: - NonThruConfirmed - NonThruConfirmedCheckedIn - NonThruConfirmedNoShow - NonThruStandby - NonThruStandbyCheckedIn - ThruConfirmed - ThruConfirmedCheckedIn - ThruConfirmedNoShow - ThruStandby - ThruStandbyCheckedIn - CheckedIn - CheckedInBoarded - CheckedInNotBoarded - CheckedInNotBoardedBagChecked - CheckedInNotBoardedBagAdded - All - CheckedInWithoutSeat - Irop - WithoutSeat - WithCabinChange - WithTravelDocument - CheckedInUnfulfilledAppsRequirment - CheckedInUnfulfilledApisRequirment - CheckedInUnfulfilledAqqRequirment - WithExtraSeat - WithInboundConnection - OnLockOrWarningQueue - WithCustomerAccount - WithDownlineFlight - WithManifestComment - WithSsr - WithoutTravelDocument - WithPremiumFare - WithSeat - OnReseatingQueue - WithUnfulfilledDocCheckRequirement - WithTicketTypeIndicator - Selectee - CheckedInWithUnfulfilledDocCheckRequirement - CheckedInWithOverriddenClearance - CheckedInWithAutoAssignedClearance - CheckedInWithOverriddenClearanceNeeded - WithSpecificSsr - BagRemoved - Child - WithInfant - UnhappyWithSeat - NonThruStandbyNotCheckedIn - BagAdded - BagChecked enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 ManifestFilterOptions: type: object additionalProperties: false properties: type: $ref: '#/components/schemas/ManifestPassengerFilterType' displayName: type: - string - 'null' showInManifestView: type: boolean showInSeatsManagement: type: boolean showInAtAGlance: type: boolean defaultSortType: $ref: '#/components/schemas/ManifestPassengerSortType' Message_2: type: object additionalProperties: false properties: code: type: - string - 'null' type: type: - string - 'null' value: type: - string - 'null' status: $ref: '#/components/schemas/MessageStatus_2' details: type: - object - 'null' additionalProperties: type: string BoardingScanRegularExpression: type: object additionalProperties: false properties: scanType: $ref: '#/components/schemas/BoardingScanType' regularExpression: type: - string - 'null' captureGroupNames: type: - array - 'null' items: $ref: '#/components/schemas/BoardingScanRegularExpressionCaptureGroupName' CheckinGeneralRequirementTypeDetails: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinGeneralRequirementType' step: $ref: '#/components/schemas/CheckinStep' BoardingScanType: type: integer description: '0 = Unknown 1 = BoardingPassLong1Segment 2 = BoardingPassLong2Segment 3 = BoardingPassLong3Segment 4 = BoardingPassLong4Segment 5 = BoardingPassShort3 6 = BoardingPassShort3WithOpSuffix 7 = BoardingPassOffline3 8 = BoardingPassShort4WithOpSuffix 9 = BoardingPassShort4 10 = BoardingPassOffline4 11 = BoardingPassShort2WithOpSuffix 12 = BoardingPassShort2 13 = BoardingPassOffline2 14 = BoardingPassShort1WithOpSuffix 15 = BoardingPassShort1 16 = BoardingPassOffline1 17 = Biometric1 18 = Biometric2' x-enumNames: - Unknown - BoardingPassLong1Segment - BoardingPassLong2Segment - BoardingPassLong3Segment - BoardingPassLong4Segment - BoardingPassShort3 - BoardingPassShort3WithOpSuffix - BoardingPassOffline3 - BoardingPassShort4WithOpSuffix - BoardingPassShort4 - BoardingPassOffline4 - BoardingPassShort2WithOpSuffix - BoardingPassShort2 - BoardingPassOffline2 - BoardingPassShort1WithOpSuffix - BoardingPassShort1 - BoardingPassOffline1 - Biometric1 - Biometric2 enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 PairedSsrConfirmation: type: object additionalProperties: false properties: name: type: - string - 'null' prohibitedSsr: type: - string - 'null' promptText: type: - string - 'null' results: type: - string - 'null' reasonCodeList: type: - array - 'null' items: type: string clearedSsr: type: - string - 'null' CheckinSecurityRequirementTypeDetails: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinSecurityRequirementType' step: $ref: '#/components/schemas/CheckinStep' KioskSettings: type: object additionalProperties: false properties: bagTagPrinter: $ref: '#/components/schemas/PrinterRequest' boardingPassPrinter: $ref: '#/components/schemas/PrinterRequest' receiptPrinter: $ref: '#/components/schemas/PrinterRequest' defaultStationCode: type: - string - 'null' DeviceManagerSettingsRequest: type: object additionalProperties: false required: - locationCode - workstationName - systemTypes properties: lastUpdate: type: string format: date-time locationCode: type: string description: The location code to retrieve settings for. minLength: 1 workstationName: type: string minLength: 1 systemTypes: type: array items: $ref: '#/components/schemas/DeviceManagerSystemType' IJsonResponse_2: type: object additionalProperties: false properties: data: {} errors: type: - array - 'null' items: $ref: '#/components/schemas/ErrorResponse_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/Message_2' CheckinGeneralRequirementType: type: integer description: '0 = Unknown 1 = ApiCheckInNotAllowed 2 = CannotSelectOtherAirline 3 = CannotSelectThirdPartyDcsControlled 4 = CannotUndoCheckInPassenger 5 = CheckInClosed 6 = CheckInNotOpen 7 = ExceededLidCount 8 = FlightNotFound 9 = FlightNotOpenForCheckIn 10 = InvalidPricingStatus 11 = InventoryLegNotFound 12 = InventoryLegOpNotFound 13 = MissingRequiredSsr 14 = MissingSeatAssignment 15 = PassengerMissingName 16 = PassengerOnLockQueue 17 = PassengerAlreadyBoarded 18 = PassengerAlreadyCheckedIn 19 = PassengerNotCheckedIn 20 = PassengerNotConfirmed 21 = PassengerNotFound 22 = PassengerNotOnOtherAirline 23 = PassengerNotStandby 24 = PaymentPending 25 = PaymentPendingCustomerAction 26 = PaymentRequired 27 = PreviousFlightNotCheckedIn 28 = SsrNotFoundInSystem 29 = TicketNumberPull 30 = TicketNumberRequired 31 = UndoCheckInClosed 32 = UndoCheckInNotOpen 33 = MissingTicketNumber 34 = MissingEmdCoupon 35 = StandbyPassengerNotAllowed 36 = CannotSelectStandbyWithConfirmedFlight 37 = FlightStatusNotAllowed 38 = CannotCheckInPassengersWithMixedStatus 39 = CannotSelectSegment 40 = SameDayDisabled' x-enumNames: - Unknown - ApiCheckInNotAllowed - CannotSelectOtherAirline - CannotSelectThirdPartyDcsControlled - CannotUndoCheckInPassenger - CheckInClosed - CheckInNotOpen - ExceededLidCount - FlightNotFound - FlightNotOpenForCheckIn - InvalidPricingStatus - InventoryLegNotFound - InventoryLegOpNotFound - MissingRequiredSsr - MissingSeatAssignment - PassengerMissingName - PassengerOnLockQueue - PassengerAlreadyBoarded - PassengerAlreadyCheckedIn - PassengerNotCheckedIn - PassengerNotConfirmed - PassengerNotFound - PassengerNotOnOtherAirline - PassengerNotStandby - PaymentPending - PaymentPendingCustomerAction - PaymentRequired - PreviousFlightNotCheckedIn - SsrNotFoundInSystem - TicketNumberPull - TicketNumberRequired - UndoCheckInClosed - UndoCheckInNotOpen - MissingTicketNumber - MissingEmdCoupon - StandbyPassengerNotAllowed - CannotSelectStandbyWithConfirmedFlight - FlightStatusNotAllowed - CannotCheckInPassengersWithMixedStatus - CannotSelectSegment - SameDayDisabled enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 securitySchemes: JWT: type: http description: Paste your JWT token from the token endpoint. scheme: bearer bearerFormat: jwt x-refined-from: - tui-group-tui-newskies-digital-api-openapi.yml - tui-group-tui-newskies-gonow-api-openapi.yml x-header: 'This API returns the price and availability for TUI''s packages specifically for OTA''s according to the G7 standard. ' x-summary: "This API returns the price and availability for TUI's packages specifically for OTA's according to the G7 standard.\nThe Travelmessage API returns information on all the available tui.nl packages, along with other relevant details such as price, extras, etc. for this specified package. \nThis API also allows to start a bookingdialogue for these packages.\n"