x-generator: NSwag v14.2.0.0 (NJsonSchema v11.1.0.0 (Newtonsoft.Json v13.0.0.0)) openapi: 3.0.0 info: title: NewSkies-GoNow-Api description: Navitaire GoNow Api version: 5.2.6.69 servers: - url: https://prod.api.tui/flight/newskies/gonow description: TUI Prod - url: https://playground.api.tui/flight/newskies/gonow description: TUI Playground paths: /api/dcs/v3/baggage: post: tags: - baggage summary: Adds a list of bags to a booking. description: "Optional record locator determines whether this endpoint behaves\ \ statelessly or modifies the booking in state. \n Including the record\ \ locator will add the bags statelessly without assigning any baggage group.\ \ \n Omitting the record locator will add the bags to the booking in state,\ \ \n assigning a baggage group for the specified passenger, \n with\ \ any other passengers specified by otherPassengersAlternateKeys.\n\nGraphQL\ \ endpoint: dcsCreateBagsV3" operationId: dcs_v3_baggage_post requestBody: x-name: request description: List of bags to add content: application/json: schema: $ref: '#/components/schemas/BaggageAddRequestV3' required: true x-position: 1 responses: '201': description: List of bag keys added. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBaggageAddResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/boardingDevices/bgrCommands: get: tags: - boardingDevices summary: Generates commands for all BGR actions except for Connect. description: 'For post-board, separate command lists are returned for different boarding response scenarios. These post-board lists contain tokenized commands, where the tokens should be replaced by the client with a specific passenger''s data before sending the commands to the BGR. Supported tokens are %%FirstName%%, %%LastName%%, %%BoardingSequence%%, %%UnitDesignator%%, and %%ErrorMessage%%. GraphQL endpoint: dcsGenerateBgrCommands' operationId: dcs_v1_boardingDevices_bgrCommands_get parameters: - name: BoardingDeviceKey in: query schema: type: string nullable: true x-position: 1 - name: LegKey in: query schema: type: string nullable: true x-position: 2 - name: LocationCode in: query description: 'The location code specifying which command generation rules will be used. If not specified, the default location code from the JWT will be used.' schema: type: string nullable: true x-position: 3 responses: '200': description: BGR command strings for each action and post-board scenario. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBgrCommandsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v2/bookings/searchByScan: post: tags: - bookings summary: Parses scanner output and performs a booking search based on the type of scan. description: 'GraphQL endpoint: dcsSearchByScan' operationId: dcs_v2_bookings_searchByScan_post requestBody: x-name: request description: Scan data with optional origin and departureDate. content: application/json: schema: $ref: '#/components/schemas/SearchByScanRequestV2' required: true x-position: 1 responses: '200': description: A list of booking search results. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfBookingSummary' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/checkin: post: tags: - checkin summary: Checks in a list of passengers on the given segments. description: 'GraphQL endpoint: dcsPerformCheckin' operationId: dcs_v1_checkin_post requestBody: x-name: request description: Checkin request including a list of segment keys and passengers content: application/json: schema: $ref: '#/components/schemas/CheckinRequest' required: true x-position: 1 responses: '200': description: Response indicating success or error information for each passenger. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinResponse' examples: UnexpectedError: description: An unexpected error has occurred while committing changes to the reservation. (FPrc1000) value: data: passengers: - passengerAlternateKey: XXXXXX successfulSegments: - segmentKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX warnings: [] securityInfo: null iatciMessages: null failedSegments: - errors: - code: FPrc1000 message: An unexpected error has occurred while committing changes to the reservation. (FPrc1000) rawMessage: '' segmentKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY overrides: null warnings: [] securityInfo: null iatciMessages: null PaymentRequiredToCheckinPassenger: description: Unable to check in the passenger because payment is required. (FPrc1050) value: data: passengers: - passengerAlternateKey: XXXXXX successfulSegments: - segmentKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX warnings: [] securityInfo: null iatciMessages: null failedSegments: - errors: - code: FPrc1050 message: Unable to check in the passenger because payment is required. (FPrc1050) rawMessage: '' segmentKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY overrides: null warnings: [] securityInfo: null iatciMessages: null CheckInClosed: description: Check in has closed. (Oper1111) value: data: passengers: - passengerAlternateKey: XXXXXX successfulSegments: - segmentKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX warnings: [] securityInfo: null iatciMessages: null failedSegments: - errors: - code: Oper1111 message: Check in has closed. (Oper1111) rawMessage: '' segmentKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY overrides: null warnings: [] securityInfo: null iatciMessages: null DocumentVerificationFailedPassengerInhibited: description: Document verification failed because passenger is inhibited. (Oper1087) value: data: passengers: - passengerAlternateKey: XXXXXX successfulSegments: - segmentKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX warnings: [] securityInfo: null iatciMessages: null failedSegments: - errors: - code: Oper1087 message: Document verification failed because passenger is inhibited. (Oper1087) rawMessage: '' segmentKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY overrides: null warnings: [] securityInfo: null iatciMessages: null MissingSeatAssignmentsOnFlightNumber: description: The passenger cannot be checked in because there is a missing seat assignment on a flight. (FPrc1013) value: data: passengers: - passengerAlternateKey: XXXXXX successfulSegments: - segmentKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX warnings: [] securityInfo: null iatciMessages: null failedSegments: - errors: - code: FPrc1013 message: The passenger cannot be checked in because there is a missing seat assignment on a flight. (FPrc1013) rawMessage: '' segmentKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY overrides: null warnings: [] securityInfo: null iatciMessages: null ScheduleCancellation: description: Passenger is on SCHCNL queue. Queue Event - ScheduleCancellation value: data: passengers: - passengerAlternateKey: XXXXXX successfulSegments: - segmentKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX warnings: - Passenger is on SCHCNL queue. Queue Event - ScheduleCancellation securityInfo: null iatciMessages: null failedSegments: [] '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Validation:nsk:Booking:NoBookingFound: description: No booking was found, cannot perform operation. value: errors: - id: null code: Validation:nsk:Booking:NoBookingFound message: Validation:nsk:Booking:NoBookingFound type: Error details: message: No booking was found, cannot perform operation. rawMessage: null 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 segmentKey:InvalidApiKey: description: 'Invalid segmentKey: XXXXX' value: errors: - id: null code: segmentKey:InvalidApiKey message: segmentKey:InvalidApiKey type: Error details: message: 'Invalid segmentKey: XXXXX' rawMessage: null 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 '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - checkin summary: Removes the checked-in status for a list of passengers on the given segments. description: 'This endpoint accepts manifest segment keys or booking segment keys GraphQL endpoint: dcsUndoCheckin' operationId: dcs_v1_checkin_delete requestBody: x-name: request description: Undo-checkin request including a list of segment keys and passengers content: application/json: schema: $ref: '#/components/schemas/UndoCheckinRequest' required: true x-position: 1 responses: '200': description: Response indicating success or error information for each passenger. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/checkin/requirements/custom: post: tags: - checkin summary: Gets custom requirements (AKA UserFlow Workflow) for the booking in state. description: 'These requirements specify which pages in the client app are required by the client config to be visited before checking in. Client apps may track or ignore these requirements to meet their own design specifications. Check-in is never blocked by whether these requirements have been met. GraphQL endpoint: dcsGetCheckinCustomRequirementsStateful' operationId: dcs_v1_checkin_requirements_custom_post requestBody: x-name: request description: Passengers and segments to retrieve requirements for. content: application/json: schema: $ref: '#/components/schemas/CheckinSecurityRequirementsRequest' required: true x-position: 1 responses: '200': description: Passengers' custom checkin requirements. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfCheckinStepCustomRequirements' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/checkin/requirements/general: post: tags: - checkin summary: 'Gets general checkin requirements for the booking in state. Does not get government security requirements or custom requirements.' description: 'GraphQL endpoint: dcsGetCheckinGeneralRequirementsStateful' operationId: dcs_v1_checkin_requirements_general_post requestBody: x-name: request description: Passengers and segments to retrieve requirements for. content: application/json: schema: $ref: '#/components/schemas/CheckinGeneralRequirementsRequest' required: true x-position: 1 responses: '200': description: Passengers' general checkin requirements. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinGeneralRequirementsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/gss/v1/checkin/requirements/security: post: tags: - checkin summary: Gets government security checkin requirements for the booking in state. description: 'GraphQL endpoint: dcsGetCheckinSecurityRequirementsStateful' operationId: gss_v1_checkin_requirements_security_post requestBody: x-name: request description: Passengers and segments to retrieve requirements for. content: application/json: schema: $ref: '#/components/schemas/CheckinSecurityRequirementsRequest' required: true x-position: 1 responses: '200': description: Passengers' government security checkin requirements. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinSecurityRequirementsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/deviceManagers/{deviceManagerKey}: get: tags: - deviceManagers summary: Retrieves device manager info for the specified device manager key. description: 'GraphQL endpoint: dcsGetDeviceManagerInfo' operationId: dcs_v1_deviceManagers_deviceManagerKey_get parameters: - name: deviceManagerKey in: path required: true description: The device manager key. schema: type: string x-position: 1 responses: '200': description: The device manager info. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDeviceManagerInfo' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/disruption/combineSegments: post: tags: - disruption summary: 'Combines a list of segments into a properly formed journey and determines whether that journey contains ad hoc connections.' description: 'GraphQL endpoint: dcsCombineDisruptionSegments' operationId: dcs_v1_disruption_combineSegments_post requestBody: x-name: request description: A list of segment keys, each with its associated leg keys. content: application/json: schema: type: array items: $ref: '#/components/schemas/SegmentKeyInfo' required: true x-position: 1 responses: '200': description: A properly formed journey, including whether the journey contains ad hoc connections. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDisruptionCombinedJourney' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/disruption/fromLegs: get: tags: - disruption summary: 'Uses search criteria to retrieve a list of legs from which passengers can be moved in a disruption.' description: "Use the dotREZ NSK API's GET /api/nsk/v1/settings/booking/reserveFlights\ \ to retrieve\nrelated role settings:\n \n \n daysBeforeIrop:\ \ This value must be a positive number, and the departure\n date of\ \ the request must not be more than this number of days after today.\n \ \ \n \n allowMove: This value must not be set to MoveFlightCode.NotAllowed.\n\ \ \n \nUse the dotREZ NSK API's GET /api/nsk/v1/settings/general/operations\ \ to retrieve\nrelated role setting:\n \n \n allowConsoleIrop:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetDisruptionFromLegs" operationId: dcs_v1_disruption_fromLegs_get parameters: - name: GetIropOnly in: query schema: type: boolean x-position: 1 - name: CarrierCode in: query schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 2 - name: DepartureDate in: query schema: type: string format: date-time nullable: true x-position: 3 - name: Origin in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 4 - name: Destination in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 5 - name: FlightNumber in: query schema: type: string nullable: true x-position: 6 - name: OpSuffix in: query schema: type: string maxLength: 1 minLength: 0 nullable: true x-position: 7 responses: '200': description: The list of legs, which includes information relevant to a disruption. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfDisruptionFromLeg' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/disruption/fromLegs/{legKey}/finalDestinations: get: tags: - disruption summary: 'Retrieves a list of the final destination journeys for the passengers from a given disruption from-leg.' description: 'GraphQL endpoint: dcsGetDisruptionFinalDestinations' operationId: dcs_v1_disruption_fromLegs_legKey_finalDestinations_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: 'The list of final destination journeys, which includes information relevant to a disruption.' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfDisruptionFinalDestinationJourney' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/disruption/move: post: tags: - disruption summary: Performs a disruption move operation (IROP or diversion) for a group of bookings. description: "Use the dotREZ NSK API's GET /api/nsk/v1/settings/booking/reserveFlights\ \ to retrieve\nrelated role settings:\n \n \n daysBeforeIrop:\ \ This value must be a positive number, and the departure\n date of\ \ the request must not be more than this number of days after today.\n \ \ \n \n allowMove: This value must not be set to MoveFlightCode.NotAllowed.\n\ \ \n \n allowMoveOverbook: If InventoryControlType in\ \ the request is set to\n OversellSpace, this value must be set to\ \ OverbookControl.CanOverbookLeg.\n \n \n allowCreateAdhocConnect:\ \ If ToJourneyKey in the request corresponds to a\n journey containing\ \ any ad hoc connections, this value must be true.\n \n \nUse the\ \ dotREZ NSK API's GET /api/nsk/v1/settings/general/operations to retrieve\n\ related role settings:\n \n \n allowConsoleIrop: This value\ \ must be true.\n \n \n allowDiversionIrop: If MoveType\ \ in the request is set to\n DisruptionMoveType.Diversion, this value\ \ must be true.\n \n \n allowIropOversellOnToFlight:\ \ If InventoryControlType in the request is set to\n OversellSpace,\ \ this value must be true.\n \n \nTo performs a stateful move operation\ \ (IROP or diversion), use the dotREZ NSK API's\nPOST /api/nsk/v1/trip/move/irop.\n\ \nGraphQL endpoint: dcsPerformDisruptionMove" operationId: dcs_v1_disruption_move_post requestBody: x-name: request description: The journey and booking data required to perform the move. content: application/json: schema: $ref: '#/components/schemas/DisruptionMoveRequest' required: true x-position: 1 responses: '200': description: 'The disruption move response specifying which bookings were successfully moved and which ones encountered errors.' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDisruptionMoveResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/disruption/toJourneys: get: tags: - disruption summary: 'Uses search criteria to retrieve a list of journeys to which passengers can be moved in a disruption.' description: 'GraphQL endpoint: dcsGetDisruptionToJourneys' operationId: dcs_v1_disruption_toJourneys_get parameters: - name: FlightType in: query description: " \nEnumeration values: 0 = All, 1 = NonStop, 2 = Through, 3\ \ = Direct, 4 = Connect" schema: $ref: '#/components/schemas/FlightType' x-position: 1 - name: IncludeNextDay in: query schema: type: boolean x-position: 2 - name: CarrierCode in: query schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 3 - name: DepartureDate in: query schema: type: string format: date-time nullable: true x-position: 4 - name: Origin in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 5 - name: Destination in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 6 - name: FlightNumber in: query schema: type: string nullable: true x-position: 7 - name: OpSuffix in: query schema: type: string maxLength: 1 minLength: 0 nullable: true x-position: 8 responses: '200': description: The list of journeys, which includes information relevant to a disruption. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfDisruptionToJourney' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/documents/{travelDocumentKey}/scannedData: put: tags: - documents summary: 'Parses scanner output and updates a specific passenger or infant''s travel document for the booking in state.' description: 'The scanned data must belong to the same type of document and be issued by the same country as the one specified by the given travel document key. The rest of the document''s information will be updated from the scanned data. Updates booking passenger information with the scanned data if it does not match the document. GraphQL endpoint: dcsUpdateTravelDocumentFromScanStateful' operationId: dcs_v1_documents_travelDocumentKey_scannedData_put parameters: - name: travelDocumentKey in: path required: true description: Document to update. schema: type: string x-position: 1 requestBody: x-name: request description: Scanned data to update the document. content: application/json: schema: $ref: '#/components/schemas/ScannedDocumentRequest' required: true x-position: 2 responses: '200': description: Null data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/documents/scannedData: post: tags: - documents summary: 'Parses scanner output and creates a new travel document for a specific passenger or infant on the booking in state.' description: 'Updates booking passenger information with the scanned data if it does not match the document. GraphQL endpoint: dcsCreateTravelDocumentFromScanStateful' operationId: dcs_v1_documents_scannedData_post requestBody: x-name: request description: Scanned data to add as a new document. content: application/json: schema: $ref: '#/components/schemas/ScannedDocumentRequest' required: true x-position: 1 responses: '200': description: The travel document key for the newly added document. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/v2/graph/{queryName}: post: tags: - graph operationId: v2_graph_queryName_post parameters: - name: queryName in: path required: true schema: type: string x-position: 2 - name: cachedResults in: query schema: type: boolean x-position: 3 requestBody: x-name: query content: application/json: schema: $ref: '#/components/schemas/GraphQlQueryv2' examples: Simple Graph Request: description: Its recommended that you use a graph specific tool for this endpoint. See the developer documentation for more information. value: query: '{tokenKeepAlive}' variables: null cachedResults: false required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfObject' examples: Simple Response: description: The response will be json and dynamic to your graph query. value: data: tokenKeepAlive: true /api/v3/health: get: tags: - health operationId: v3_health_get responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/EnvironmentHealth' '299': description: '' content: application/json: schema: $ref: '#/components/schemas/EnvironmentHealth' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/EnvironmentHealth' /api/dcs/v1/legs: get: tags: - legs summary: Retrieves a list of inventory legs based on search criteria. description: 'GraphQL endpoint: dcsGetLegs' operationId: dcs_v1_legs_get parameters: - name: CarrierCode in: query schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 1 - name: DepartureDate in: query schema: type: string format: date-time nullable: true x-position: 2 - name: Origin in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 3 - name: Destination in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 4 - name: FlightNumber in: query schema: type: string nullable: true x-position: 5 - name: OpSuffix in: query schema: type: string maxLength: 1 minLength: 0 nullable: true x-position: 6 responses: '200': description: The list of inventory legs. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfLeg' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/gss/v1/legs/{legKey}/close/requirements: get: tags: - legs summary: Gets government security requirements that are required for closing the specified leg. description: 'GraphQL endpoint: dcsGetLegCloseSecurityRequirements' operationId: gss_v1_legs_legKey_close_requirements_get parameters: - name: legKey in: path required: true description: The unique leg key. Leg keys can be retrieved via GET /api/dcs/v1/legs. schema: type: string x-position: 1 responses: '200': description: List of government security requirements that must be satisfied in order to close the specified flight leg. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfLegCloseSecurityRequirement' examples: Success example: description: An example 200OK Successful response. value: data: - governmentProgram: USDHS governmentProgramType: 1 programDescription: United States - SecureFlight eligibleDocuments: - typeCode: A group: 2 typeName: Permanent Resident Card isPrimary: false - typeCode: C group: 1 typeName: U.S. Alien Registration Card isPrimary: false - typeCode: F group: 3 typeName: Facilitation Document isPrimary: false - typeCode: G group: 18 typeName: Government ID card isPrimary: false - typeCode: M group: 5 typeName: Military ID Card isPrimary: false - typeCode: P group: 6 typeName: Permanent Resident Card isPrimary: false - typeCode: PD group: 6 typeName: Diplomatic Passport isPrimary: false - typeCode: PM group: 6 typeName: Missionary Passport isPrimary: false - typeCode: PS group: 6 typeName: Special Passport isPrimary: false - typeCode: T group: 17 typeName: Refugee Travel Document isPrimary: false - typeCode: V group: 9 typeName: Travel Visa isPrimary: false documentRequiredFields: - 6 - 9 - 10 - 0 - 2 additionalDataRequiredFields: - 5 - 6 - 4 - 3 minVerifiedDocumentCount: 1 flightCloseCountryCodes: - US '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid legKey: description: Example error response when the leg key is invalid. value: errors: - id: a70ddb46-fc1a-bed4-9ae9-b3c4eb6be908 code: legKey:InvalidApiKey message: 'Invalid legKey: asdf' type: Validation details: message: 'Invalid legKey: asdf' param: legKey validation: InvalidApiKey rawMessage: null 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 '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/legs/{legKey}/operationsInfo: get: tags: - legs summary: 'Retrieves operations (AKA flight following) info for the specified inventory leg. In the case of passive flights, only status, boardingTimeOffset, and schedule-related fields are populated.' description: 'This endpoint replaces the dotREZ NSK API''s GET /api/nsk/v2/trip/info/{legKey}/status. This endpoint uses a more detailed and operationally-appropriate enum for the status field. GraphQL endpoint: dcsGetOperationsInfo' operationId: dcs_v1_legs_legKey_operationsInfo_get parameters: - name: legKey in: path required: true description: The leg key or manifest leg key. schema: type: string x-position: 1 responses: '200': description: The operations info. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOperationsInfo' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid legKey: description: Example error response when the leg key is invalid. value: errors: - id: a70ddb46-fc1a-bed4-9ae9-b3c4eb6be908 code: legKey:InvalidApiKey message: 'Invalid legKey: asdf' type: Validation details: message: 'Invalid legKey: asdf' param: legKey validation: InvalidApiKey rawMessage: null 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 '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/legs/{legKey}/thruLegs: get: tags: - legs summary: Retrieves a list of thru legs for the specified leg. description: 'GraphQL endpoint: dcsGetThruLegs' operationId: dcs_v1_legs_legKey_thruLegs_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: List of legs that the specified leg has a direct downline connection to. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfLegInfo' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid legKey: description: Example error response when the leg key is invalid. value: errors: - id: a70ddb46-fc1a-bed4-9ae9-b3c4eb6be908 code: legKey:InvalidApiKey message: 'Invalid legKey: asdf' type: Validation details: message: 'Invalid legKey: asdf' param: legKey validation: InvalidApiKey rawMessage: null 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 '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/logs: post: tags: - logs summary: Pushes a client side log entry to the server. operationId: dcs_v1_logs_post requestBody: x-name: request description: Request to create a log entry. content: application/json: schema: $ref: '#/components/schemas/LogRequest' required: true x-position: 1 responses: '200': description: Null data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/logs/file: post: tags: - logs summary: Uploads a log file to the server. operationId: dcs_v1_logs_file_post requestBody: content: multipart/form-data: schema: type: object properties: SystemType: type: string nullable: true MachineName: type: string nullable: true Message: type: string nullable: true File: type: string format: binary nullable: true responses: '200': description: Null data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/passengers: get: tags: - passengers summary: Uses search criteria to retrieve a list of passengers. description: 'GraphQL endpoint: dcsGetPassengers' operationId: dcs_v1_passengers_get parameters: - name: CarrierCode in: query schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 1 - name: DepartureDate in: query schema: type: string format: date-time nullable: true x-position: 2 - name: Origin in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 3 - name: Destination in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 4 - name: FlightNumber in: query schema: type: string nullable: true x-position: 5 - name: OpSuffix in: query schema: type: string maxLength: 1 minLength: 0 nullable: true x-position: 6 - name: FirstName in: query schema: type: string nullable: true x-position: 7 - name: LastName in: query schema: type: string nullable: true x-position: 8 - name: RecordLocator in: query schema: type: string nullable: true x-position: 9 - name: SearchByRecordLocatorOnly in: query description: 'If true, recordLocator is required and all other fields are ignored. If false, carrierCode, departureDate, and origin are required.' schema: type: boolean x-position: 10 responses: '200': description: The list of passengers. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfPassenger' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers: get: tags: - printers summary: Gets the list of TCP/IP printers for the logged in agent's location. description: 'GraphQL endpoint: dcsGetPrinters' operationId: dcs_v1_printers_get responses: '200': description: The list of printers. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfPrinter' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/bagTags/passenger/print: post: tags: - printers summary: Performs bag tag print for bags of the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. GraphQL endpoint: dcsPerformBagTagPrint' operationId: dcs_v1_printers_bagTags_passenger_print_post requestBody: x-name: request description: Bag tag print request. content: application/json: schema: $ref: '#/components/schemas/BagTagPrintRequest' required: true x-position: 1 responses: '200': description: Print result data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrinterCommandsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/bagTags/passenger/printStreams: post: tags: - printers summary: Generates bag tag print streams for bags of the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. If the user is not an agent, then the specified booking must be in state and unmodified, and the specified bag tags must be in the Added state (i.e. they must not have been printed already). GraphQL endpoint: dcsGenerateBagTagPrintStreams' operationId: dcs_v1_printers_bagTags_passenger_printStreams_post requestBody: x-name: request description: Bag tag print streams request. content: application/json: schema: $ref: '#/components/schemas/BagTagPrintStreamsRequest' required: true x-position: 1 responses: '200': description: Print stream strings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfBagTagPrintStreams' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/boardingPasses/print: post: tags: - printers summary: Performs boarding pass print for the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. Accepts manifest segment keys or booking segment keys. GraphQL endpoint: dcsPerformBoardingPassPrint' operationId: dcs_v1_printers_boardingPasses_print_post requestBody: x-name: request description: Boarding pass print request. content: application/json: schema: $ref: '#/components/schemas/BoardingPassPrintRequest' required: true x-position: 1 responses: '200': description: Print result data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrinterCommandsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/boardingPasses/printStreams: post: tags: - printers summary: Generates boarding pass print streams for the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. If the user is not an agent, then the specified booking must be in state and unmodified. GraphQL endpoint: dcsGenerateBoardingPassPrintStreams' operationId: dcs_v1_printers_boardingPasses_printStreams_post requestBody: x-name: request description: Boarding pass print streams request. content: application/json: schema: $ref: '#/components/schemas/BoardingPassPrintStreamsRequest' required: true x-position: 1 responses: '200': description: Print stream strings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/initializationStreams: post: tags: - printers summary: Retrieves initialization streams for setting up a printer. description: 'This endpoint uses the session''s location code if one isn''t provided. GraphQL endpoint: dcsGetPrinterInitializationStreams' operationId: dcs_v1_printers_initializationStreams_post requestBody: x-name: request description: Printer initialization streams request. content: application/json: schema: $ref: '#/components/schemas/PrinterCommandsRequest' required: true x-position: 1 responses: '200': description: Printer initialization stream strings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/initialize: post: tags: - printers summary: Performs printer initialization. description: 'This endpoint uses the session''s location code if one isn''t provided. GraphQL endpoint: dcsPerformPrinterInitialization' operationId: dcs_v1_printers_initialize_post requestBody: x-name: request description: Printer initialization request. content: application/json: schema: $ref: '#/components/schemas/PrinterInitializationRequest' required: true x-position: 1 responses: '200': description: Print result data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrinterCommandsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/receipts/booking/print: post: tags: - printers summary: Performs receipt print for the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. GraphQL endpoint: dcsPerformBookingReceiptPrint' operationId: dcs_v1_printers_receipts_booking_print_post requestBody: x-name: request description: Booking receipt print request. content: application/json: schema: $ref: '#/components/schemas/BookingReceiptPrintRequest' required: true x-position: 1 responses: '200': description: Print result data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrinterCommandsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/receipts/booking/printStreams: post: tags: - printers summary: Generates receipt print streams for the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. If the user is not an agent, then the specified booking must be in state and unmodified. Accepts manifest segment keys or booking segment keys. GraphQL endpoint: dcsGenerateBookingReceiptPrintStreams' operationId: dcs_v1_printers_receipts_booking_printStreams_post requestBody: x-name: request description: Booking receipt print streams request. content: application/json: schema: $ref: '#/components/schemas/BookingReceiptPrintStreamsRequest' required: true x-position: 1 responses: '200': description: Print stream strings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/receipts/passenger/print: post: tags: - printers summary: Performs receipt print for selected passengers of the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. GraphQL endpoint: dcsPerformPassengerReceiptPrint' operationId: dcs_v1_printers_receipts_passenger_print_post requestBody: x-name: request description: Passenger receipt print request. content: application/json: schema: $ref: '#/components/schemas/PassengerReceiptPrintRequest' required: true x-position: 1 responses: '200': description: Print result data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrinterCommandsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/receipts/passenger/printStreams: post: tags: - printers summary: Generates receipt print streams for selected passengers of the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. If the user is not an agent, then the specified booking must be in state and unmodified. GraphQL endpoint: dcsGeneratePassengerReceiptPrintStreams' operationId: dcs_v1_printers_receipts_passenger_printStreams_post requestBody: x-name: request description: Passenger receipt print streams request. content: application/json: schema: $ref: '#/components/schemas/PassengerReceiptPrintStreamsRequest' required: true x-position: 1 responses: '200': description: Print stream strings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/receipts/payment/print: post: tags: - printers summary: Performs receipt print for a specific payment of the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. GraphQL endpoint: dcsPerformPaymentReceiptPrint' operationId: dcs_v1_printers_receipts_payment_print_post requestBody: x-name: request description: Payment receipt print request. content: application/json: schema: $ref: '#/components/schemas/PaymentReceiptPrintRequest' required: true x-position: 1 responses: '200': description: Print result data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrinterCommandsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/receipts/payment/printStreams: post: tags: - printers summary: Generates receipt print streams for a specific payment of the specified booking. description: 'This endpoint uses the session''s location code if one isn''t provided. If the user is not an agent, then the specified booking must be in state and unmodified. GraphQL endpoint: dcsGeneratePaymentReceiptPrintStreams' operationId: dcs_v1_printers_receipts_payment_printStreams_post requestBody: x-name: request description: Payment receipt print streams request. content: application/json: schema: $ref: '#/components/schemas/PaymentReceiptPrintStreamsRequest' required: true x-position: 1 responses: '200': description: Print stream strings. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/availabilityReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for an availability report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowAvailabilityReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetAvailabilityReportPrintPreview" operationId: dcs_v1_printers_reports_availabilityReport_printPreview_get parameters: - name: DepartureDate in: query schema: type: string format: date-time nullable: true x-position: 1 - name: CarrierCode in: query schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 2 - name: Origin in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 3 - name: Destination in: query schema: type: string nullable: true x-position: 4 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/availabilityReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for an availability report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowAvailabilityReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetAvailabilityReportPrintStreams" operationId: dcs_v1_printers_reports_availabilityReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/AvailabilityReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/bagTagTrackingReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a bag tag tracking report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowBagTagTrackingReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetBagTagTrackingReportPrintPreview" operationId: dcs_v1_printers_reports_bagTagTrackingReport_printPreview_get parameters: - name: BagTag in: query schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 1 - name: Date in: query schema: type: string format: date-time nullable: true x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/bagTagTrackingReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a bag tag tracking report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowBagTagTrackingReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetBagTagTrackingReportPrintStreams" operationId: dcs_v1_printers_reports_bagTagTrackingReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/BagTagTrackingReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/bagWeightByLegReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for the bag weight by leg report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowBagWeightByLegReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetBagWeightByLegReportPrintPreview" operationId: dcs_v1_printers_reports_bagWeightByLegReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: WeightType in: query description: "Pounds or Kilograms (DAPI's weight type Default = Kilograms)\ \ \nEnumeration values: 1 = Pounds, 2 = Kilograms" schema: nullable: true $ref: '#/components/schemas/WeightType' x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/bagWeightByLegReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for the bag weight by leg report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowBagWeightByLegReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetBagWeightByLegReportPrintStreams" operationId: dcs_v1_printers_reports_bagWeightByLegReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/BagWeightByLegReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/checkedBaggageReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a checked baggage report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowCheckedBaggageReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetCheckedBaggageReportPrintPreview" operationId: dcs_v1_printers_reports_checkedBaggageReport_printPreview_get parameters: - name: StartDate in: query schema: type: string format: date-time nullable: true x-position: 1 - name: EndDate in: query schema: type: string format: date-time nullable: true x-position: 2 - name: PrimarySortType in: query description: " \nEnumeration values: 0 = FlightNumber, 1 = CityPair, 2 = Sequence" schema: nullable: true $ref: '#/components/schemas/CheckedBaggagePrimarySortType' x-position: 3 - name: SecondarySortType in: query description: " \nEnumeration values: 0 = Name, 1 = BagTag" schema: nullable: true $ref: '#/components/schemas/CheckedBaggageSecondarySortType' x-position: 4 - name: WeightType in: query description: "Pounds or Kilograms (DAPI's weight type Default = Kilograms)\ \ \nEnumeration values: 1 = Pounds, 2 = Kilograms" schema: nullable: true $ref: '#/components/schemas/WeightType' x-position: 5 - name: IncludeUnflownPassengers in: query schema: type: boolean nullable: true x-position: 6 - name: ShowSummaryOnly in: query schema: type: boolean nullable: true x-position: 7 - name: CarrierCode in: query schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 8 - name: FlightNumber in: query schema: type: string nullable: true x-position: 9 - name: Origin in: query schema: type: string nullable: true x-position: 10 - name: Destination in: query schema: type: string nullable: true x-position: 11 - name: AgentName in: query description: The username of the agent account that checked the baggage. schema: type: string nullable: true x-position: 12 - name: AgentDomain in: query description: 'The domain of the agent account that checked the baggage. If agentName is empty, this value is ignored.' schema: type: string nullable: true x-position: 13 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/checkedBaggageReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a checked baggage report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowCheckedBaggageReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetCheckedBaggageReportPrintStreams" operationId: dcs_v1_printers_reports_checkedBaggageReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/CheckedBaggageReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/checkInReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a check-in report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowCheckInReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetCheckInReportPrintPreview" operationId: dcs_v1_printers_reports_checkInReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: IncludeThruPassengers in: query schema: type: boolean nullable: true x-position: 2 - name: DisplayNames in: query schema: type: boolean nullable: true x-position: 3 - name: DisplaySeats in: query schema: type: boolean nullable: true x-position: 4 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/checkInReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a check-in report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowCheckInReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetCheckInReportPrintStreams" operationId: dcs_v1_printers_reports_checkInReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/CheckInReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/departureManifestReport/printStreams: post: tags: - printers/reports summary: Gets the print preview for a departure manifest report for a given leg. description: 'GraphQL endpoint: dcsGetDepartureManifestReportPrintStreams' operationId: dcs_v1_printers_reports_departureManifestReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/DepartureManifestReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/downlinePassengerAndCountReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a downline passenger and count report for a given leg. description: 'GraphQL endpoint: dcsGetDownlinePassengerAndCountReportPrintPreview' operationId: dcs_v1_printers_reports_downlinePassengerAndCountReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: IncludeIatciFlights in: query schema: type: boolean nullable: true x-position: 2 - name: ShowPassengerNames in: query schema: type: boolean nullable: true x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/downlinePassengerAndCountReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a downline passenger and count report for a given leg. description: 'GraphQL endpoint: dcsGetDownlinePassengerAndCountReportPrintStreams' operationId: dcs_v1_printers_reports_downlinePassengerAndCountReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/DownlinePassengerAndCountReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/enplanementDeplanementReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for an enplanement or deplanement report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowEnplanementDeplanementReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetEnplanementDeplanementReportPrintPreview" operationId: dcs_v1_printers_reports_enplanementDeplanementReport_printPreview_get parameters: - name: StartDate in: query schema: type: string format: date-time nullable: true x-position: 1 - name: EndDate in: query schema: type: string format: date-time nullable: true x-position: 2 - name: ShowSummaryOnly in: query schema: type: boolean nullable: true x-position: 3 - name: ReportType in: query description: " \nEnumeration values: 0 = Enplanement, 1 = Deplanement" schema: nullable: true $ref: '#/components/schemas/EnplanementDeplanementReportType' x-position: 4 - name: SegmentStatus in: query description: " \nEnumeration values: 0 = Flown, 1 = Open" schema: nullable: true $ref: '#/components/schemas/EnplanementDeplanementReportSegmentStatus' x-position: 5 - name: Station in: query schema: type: string nullable: true x-position: 6 - name: IncludeConnections in: query schema: type: boolean nullable: true x-position: 7 - name: FareClasses in: query schema: type: string nullable: true x-position: 8 - name: CarrierCode in: query schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 9 - name: StartFlightNumber in: query schema: type: string nullable: true x-position: 10 - name: EndFlightNumber in: query schema: type: string nullable: true x-position: 11 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/enplanementDeplanementReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for an enplanement or deplanement report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowEnplanementDeplanementReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetEnplanementDeplanementReportPrintStreams" operationId: dcs_v1_printers_reports_enplanementDeplanementReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/EnplanementDeplanementReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightCloseReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a flight close report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowFlightCloseReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetFlightCloseReportPrintPreview" operationId: dcs_v1_printers_reports_flightCloseReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: SortType in: query description: " \nEnumeration values: 0 = Name, 1 = Seat, 2 = Destination,\ \ 3 = Sequence" schema: nullable: true $ref: '#/components/schemas/FlightCloseSortType' x-position: 2 - name: WeightType in: query description: "Pounds or Kilograms (DAPI's weight type Default = Kilograms)\ \ \nEnumeration values: 1 = Pounds, 2 = Kilograms" schema: nullable: true $ref: '#/components/schemas/WeightType' x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightCloseReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a flight close report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowFlightCloseReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetFlightCloseReportPrintStreams" operationId: dcs_v1_printers_reports_flightCloseReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/FlightCloseReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightInformationReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a flight information report for a given leg. description: 'GraphQL endpoint: dcsGetFlightInformationReportPrintPreview' operationId: dcs_v1_printers_reports_flightInformationReport_printPreview_get parameters: - name: Origin in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 1 - name: CarrierCode in: query schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 2 - name: DepartureDate in: query schema: type: string format: date-time nullable: true x-position: 3 - name: Destination in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 4 - name: FlightNumber in: query schema: type: string nullable: true x-position: 5 - name: OpSuffix in: query schema: type: string maxLength: 1 minLength: 0 nullable: true x-position: 6 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightInformationReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a flight information report for a given leg. description: 'GraphQL endpoint: dcsGetFlightInformationReportPrintStreams' operationId: dcs_v1_printers_reports_flightInformationReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/FlightInformationReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightLoadReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a flight load report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowFlightLoadReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetFlightLoadReportPrintPreview" operationId: dcs_v1_printers_reports_flightLoadReport_printPreview_get parameters: - name: DepartureDate in: query schema: type: string format: date-time nullable: true x-position: 1 - name: Origin in: query schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 2 - name: CarrierCode in: query schema: type: string maxLength: 2 minLength: 2 nullable: true x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightLoadReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a flight load report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowFlightLoadReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetFlightLoadReportPrintStreams" operationId: dcs_v1_printers_reports_flightLoadReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/FlightLoadReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightManifestReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a flight manifest report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowFlightManifestReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetFlightManifestReportPrintPreview" operationId: dcs_v1_printers_reports_flightManifestReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: ReportType in: query description: " \nEnumeration values: 0 = FlightManifest, 1 = FlightManifestWithApisDetails,\ \ 2 = PassengerDocument" schema: nullable: true $ref: '#/components/schemas/FlightManifestReportType' x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightManifestReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a flight manifest report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowFlightManifestReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetFlightManifestReportPrintStreams" operationId: dcs_v1_printers_reports_flightManifestReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/FlightManifestReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightSummaryReport/data: get: tags: - printers/reports summary: 'Gets the zone counts and baggage counts for a flight summary report for a given leg. Client apps must calculate their own manifest counts and formatting to display a print preview.' description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowFlightSummaryReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetFlightSummaryPartialReportData" operationId: dcs_v1_printers_reports_flightSummaryReport_data_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: WeightType in: query description: "Pounds or Kilograms (DAPI's weight type Default = Kilograms)\ \ \nEnumeration values: 1 = Pounds, 2 = Kilograms" schema: nullable: true $ref: '#/components/schemas/WeightType' x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFlightSummaryPartialReport' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/flightSummaryReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a flight summary report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowFlightSummaryReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetFlightSummaryReportPrintStreams" operationId: dcs_v1_printers_reports_flightSummaryReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/FlightSummaryReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/inboundPassengerAndCountReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for an inbound passenger and count report for a given leg. description: 'GraphQL endpoint: dcsGetInboundPassengerandCountReportPrintPreview' operationId: dcs_v1_printers_reports_inboundPassengerAndCountReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: IncludeIatciFlights in: query schema: type: boolean nullable: true x-position: 2 - name: ShowPassengerNames in: query schema: type: boolean nullable: true x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/inboundPassengerAndCountReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for an inbound passenger and count report for a given leg. description: 'GraphQL endpoint: dcsGetInboundPassengerandCountReportPrintStreams' operationId: dcs_v1_printers_reports_inboundPassengerAndCountReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/InboundPassengerAndCountReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/inventoryLegOpFileReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for an inventory leg-op file report. description: 'GraphQL endpoint: dcsGetInventoryLegOpFileReportPrintPreview' operationId: dcs_v1_printers_reports_inventoryLegOpFileReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: ReportType in: query description: "Property for the Report Type of the report \nEnumeration values:\ \ 0 = Both, 1 = Weather, 2 = Flight" schema: nullable: true $ref: '#/components/schemas/InventoryLegOpFileReportType' x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/inventoryLegOpFileReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for an inventory leg-op file report. description: 'GraphQL endpoint: dcsGetInventoryLegOpFileReportPrintStreams' operationId: dcs_v1_printers_reports_inventoryLegOpFileReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/InventoryLegOpFileReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/passengerVerificationReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a passenger verification report for a given leg. description: 'GraphQL endpoint: dcsGetPassengerVerificationReportPrintPreview' operationId: dcs_v1_printers_reports_passengerVerificationReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: IncludeUnverifiedPassenger in: query schema: type: boolean nullable: true x-position: 2 - name: IncludePassengerAddress in: query schema: type: boolean nullable: true x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/passengerVerificationReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a passenger verification report for a given leg. description: 'GraphQL endpoint: dcsGetPassengerVerificationReportPrintStreams' operationId: dcs_v1_printers_reports_passengerVerificationReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/PassengerVerificationReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/paymentReceiptReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a payment receipt report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowPaymentReceiptReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetPaymentReceiptReportPrintPreview" operationId: dcs_v1_printers_reports_paymentReceiptReport_printPreview_get parameters: - name: PaymentDate in: query description: Search criteria specifying the date of the payment. schema: type: string format: date-time nullable: true x-position: 1 - name: ReportType in: query description: "The type of payment receipt report to be returned. \nEnumeration\ \ values: 0 = Summary, 1 = Detailed" schema: nullable: true $ref: '#/components/schemas/PaymentReceiptReportType' x-position: 2 - name: PaymentMethodCode in: query description: Search criteria specifying which payment method was used. schema: type: string nullable: true x-position: 3 - name: LocationCode in: query description: Search criteria specifying the location where the payment was accepted. schema: type: string nullable: true x-position: 4 - name: DepartmentCode in: query description: Search criteria specifying the department code of the agent that accepted the payment. schema: type: string nullable: true x-position: 5 - name: AgentName in: query description: Search criteria specifying the name of the agent that accepted the payment. schema: type: string nullable: true x-position: 6 - name: CurrencyCode in: query description: Search criteria specifying the currency that was used to make the payment. schema: type: string nullable: true x-position: 7 - name: BaseCurrencyCode in: query description: Search criteria specifying the base currency associated with the payment. schema: type: string nullable: true x-position: 8 - name: DisplayCurrencySource in: query description: "Specifies whether to display the currency used in the booking\ \ or in the specific payment. \nEnumeration values: 0 = Payment, 1 = Booking" schema: nullable: true $ref: '#/components/schemas/PaymentReceiptReportDisplayCurrencySource' x-position: 9 - name: TimeZoneCode in: query description: Specifies the time zone used in performing the search and displaying the report. schema: type: string nullable: true x-position: 10 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/paymentReceiptReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a payment receipt report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowPaymentReceiptReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetPaymentReceiptReportPrintStreams" operationId: dcs_v1_printers_reports_paymentReceiptReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/PaymentReceiptReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/prePostFlightManifestReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a pre or post flight manifest report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowPrePostFlightManifestReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetPrePostFlightManifestReportPrintPreview" operationId: dcs_v1_printers_reports_prePostFlightManifestReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: ReportType in: query description: " \nEnumeration values: 0 = PostFlightManifest, 1 = PreFlightManifest,\ \ 2 = PreFlightManifestWithSeatMap" schema: nullable: true $ref: '#/components/schemas/PrePostFlightManifestReportType' x-position: 2 - name: SortType in: query description: " \nEnumeration values: 0 = Seat, 1 = Name" schema: nullable: true $ref: '#/components/schemas/PrePostFlightManifestSortType' x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/prePostFlightManifestReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a pre or post flight manifest report for a given leg. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowPrePostFlightManifestReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetPrePostFlightManifestReportPrintStreams" operationId: dcs_v1_printers_reports_prePostFlightManifestReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/PrePostFlightManifestReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/segmentsByTimeReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a segments by time report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowSegmentsByTimeReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetSegmentsByTimeReportPrintPreview" operationId: dcs_v1_printers_reports_segmentsByTimeReport_printPreview_get parameters: - name: BookingDate in: query schema: type: string format: date-time nullable: true x-position: 1 - name: ChannelType in: query description: " \nEnumeration values: 0 = Default, 1 = Direct, 2 = Web, 3 =\ \ Gds, 4 = Api, 5 = DigitalApi, 6 = DigitalWeb, 7 = Ndc" schema: $ref: '#/components/schemas/ChannelType' x-position: 2 - name: CarrierCode in: query schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/segmentsByTimeReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a segments by time report. description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowSegmentsByTimeReport:\ \ This value must be true.\n\nGraphQL endpoint: dcsGetSegmentsByTimeReportPrintStreams" operationId: dcs_v1_printers_reports_segmentsByTimeReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/SegmentsByTimeReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/standardLegReport/printPreview: get: tags: - printers/reports summary: 'Gets the print preview for a standard leg report, i.e. any type of report that takes no parameters other than a legKey. The specific type of report is specified by the reportType parameter.' description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowAircraftZoneReport:\ \ This value must be true if reportType is\n \"AircraftZoneReport\"\ .\n \n \n allowCabinServiceAreaReport: This value must\ \ be true if reportType is\n \"CabinServiceAreaDetailedReport\" or\ \ \"CabinServiceAreaSummaryReport\".\n \n \n allowManifestReport:\ \ This value must be true if reportType is\n \"ManifestReport\".\n\ \ \n \n allowManifestTripDetailReport: This value must\ \ be true if reportType is\n \"ManifestWithTripDetailReport\".\n \ \ \n \n allowMealFulfillmentReport: This value must be\ \ true if reportType is\n \"MealFulfillmentDetailedReport\" or \"MealFulfillmentSummaryReport\"\ .\n \n \n allowSeatAssignmentReport: This value must\ \ be true if reportType is\n \"SeatAssignmentReport\".\n \n\ \ \n allowSelecteesByFlightReport: This value must be true\ \ if reportType is\n \"SelecteesByFlightReport\".\n\nGraphQL endpoint:\ \ dcsGetStandardLegReportPrintPreview" operationId: dcs_v1_printers_reports_standardLegReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: ReportType in: query description: " \nEnumeration values: 0 = AircraftZoneReport, 1 = AppsOverrideReport,\ \ 2 = BaggageReport, 3 = BoardingHistoryReport, 4 = CabinServiceAreaDetailedReport,\ \ 5 = CabinServiceAreaSummaryReport, 6 = DuplicateTravelDocumentReport,\ \ 7 = FlightHistoryReport, 8 = ManifestWithConnectionInformationReport,\ \ 9 = ManifestWithTripDetailReport, 10 = MealFulfillmentDetailedReport,\ \ 11 = MealFulfillmentSummaryReport, 12 = SeatAssignmentReport, 13 = SelecteesByFlightReport" schema: nullable: true $ref: '#/components/schemas/StandardLegReportType' x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/standardLegReport/printStreams: post: tags: - printers/reports summary: 'Gets the print streams for a standard leg report, i.e. any type of report that takes no parameters other than a legKey. The specific type of report is specified by the reportType parameter.' description: "Use the GoNow API's GET /api/dcs/v1/settings/operations/reports\ \ to retrieve\nrelated role setting:\n \n \n allowAircraftZoneReport:\ \ This value must be true if reportType is\n \"AircraftZoneReport\"\ .\n \n \n allowCabinServiceAreaReport: This value must\ \ be true if reportType is\n \"CabinServiceAreaDetailedReport\" or\ \ \"CabinServiceAreaSummaryReport\".\n \n \n allowManifestReport:\ \ This value must be true if reportType is\n \"ManifestReport\".\n\ \ \n \n allowManifestTripDetailReport: This value must\ \ be true if reportType is\n \"ManifestWithTripDetailReport\".\n \ \ \n \n allowMealFulfillmentReport: This value must be\ \ true if reportType is\n \"MealFulfillmentDetailedReport\" or \"MealFulfillmentSummaryReport\"\ .\n \n \n allowSeatAssignmentReport: This value must\ \ be true if reportType is\n \"SeatAssignmentReport\".\n \n\ \ \n allowSelecteesByFlightReport: This value must be true\ \ if reportType is\n \"SelecteesByFlightReport\".\n\nGraphQL endpoint:\ \ dcsGetStandardLegReportPrintStreams" operationId: dcs_v1_printers_reports_standardLegReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/StandardLegReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/transferBagTagReport/printPreview: get: tags: - printers/reports summary: Gets the print preview for a transfer bag tag report for a given leg. description: 'GraphQL endpoint: dcsGetTransferBagTagReportPrintPreview' operationId: dcs_v1_printers_reports_transferBagTagReport_printPreview_get parameters: - name: LegKey in: query schema: type: string nullable: true x-position: 1 - name: IncludeOaAndManualTags in: query schema: type: boolean nullable: true x-position: 2 - name: SortType in: query description: " \nEnumeration values: 0 = PassengerLastName, 1 = BagTag" schema: nullable: true $ref: '#/components/schemas/TransferBagTagSortType' x-position: 3 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrintPreview' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/printers/reports/transferBagTagReport/printStreams: post: tags: - printers/reports summary: Gets the print streams for a transfer bag tag report for a given leg. description: 'GraphQL endpoint: dcsGetTransferBagTagReportPrintStreams' operationId: dcs_v1_printers_reports_transferBagTagReport_printStreams_post requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/TransferBagTagReportPrintStreamsRequest' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v3/scanners/parse: post: tags: - scanners summary: 'Parses scanner output into individual data fields, returning one or more scan types based on the formats specified in the scan parser configuration.' description: 'GraphQL endpoint: dcsParseScannedDataV3' operationId: dcs_v3_scanners_parse_post requestBody: x-name: request description: Scanned data to parse. content: application/json: schema: $ref: '#/components/schemas/ParseScanRequestV2' required: true x-position: 1 responses: '200': description: Parsed scanned data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCombinedScanV3' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/segments/downline: post: tags: - segments summary: Retrieves a list of downline segments based on search criteria. description: 'GraphQL endpoint: dcsGetDownlineSegments' operationId: dcs_v1_segments_downline_post requestBody: x-name: request description: The search criteria. content: application/json: schema: $ref: '#/components/schemas/GetDownlineSegmentsRequest' required: true x-position: 1 responses: '200': description: The list of downline Segments. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDownlineSegmentsResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /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' /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' /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' /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' /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' /api/dcs/v1/ssrs/paired/comments: post: tags: - ssrs summary: Generates paired SSR comments for a booking. description: 'Optional record locator on the request determines how the booking is retrieved. If a record locator is present, this endpoint behaves statelessly, but omitting the record locator specifies that comments will be generated from the booking in state. SSR pairs and associated comment formats are defined in the setting pairedSsrConfirmationList, which can be retrieved from the GoNow API''s GET /api/dcs/v1/settings/operations/checkin. GraphQL endpoint: dcsGeneratePairedSsrComments' operationId: dcs_v1_ssrs_paired_comments_post requestBody: x-name: request description: Optional record locator, cleared SSR code, and lists of passengers and segments. content: application/json: schema: $ref: '#/components/schemas/PairedSsrCommentsRequest' required: true x-position: 1 responses: '200': description: A list of paired SSR comments. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/token: get: tags: - token summary: 'Gets token-based information about the current user that is commonly used by DCS applications.' description: 'Before calling this endpoint, you first need to login using the PUT or POST endpoint at /api/nsk/v2/token. GraphQL endpoint: dcsToken' operationId: dcs_v1_token_get responses: '200': description: Information about the current user. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDcsToken' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' components: schemas: IJsonResponseOfBaggageAddResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/BaggageAddResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' BaggageAddResponse: type: object additionalProperties: false properties: baggageKeys: type: array nullable: true items: type: string ErrorResponse: type: object additionalProperties: false properties: exception: nullable: true $ref: '#/components/schemas/Exception' rawMessage: type: string nullable: true code: type: string nullable: true message: type: string nullable: true type: type: string nullable: true number: type: integer format: int32 maximum: 99999.0 minimum: 0.0 nullable: true details: type: object nullable: true additionalProperties: type: string ActivityId: type: string nullable: true Exception: type: object additionalProperties: false properties: Message: type: string InnerException: nullable: true $ref: '#/components/schemas/Exception' Source: type: string nullable: true StackTrace: type: string nullable: true Message: type: object additionalProperties: false properties: code: type: string nullable: true type: type: string nullable: true value: type: string nullable: true status: $ref: '#/components/schemas/MessageStatus' details: type: object nullable: true additionalProperties: type: string MessageStatus: type: integer description: '0 = General 1 = Warning 2 = Critical' x-enumNames: - General - Warning - Critical enum: - 0 - 1 - 2 MessageDebug: type: object additionalProperties: false properties: code: type: string nullable: true type: type: string nullable: true value: type: string nullable: true status: $ref: '#/components/schemas/MessageStatus' details: type: object nullable: true additionalProperties: type: string rawValue: type: string nullable: true debugMode: type: string nullable: true IJsonResponse: type: object additionalProperties: false properties: data: nullable: true errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' BaggageAddRequest: type: object additionalProperties: false required: - segmentKey - passengerAlternateKey - bags properties: segmentKey: type: string minLength: 1 passengerAlternateKey: type: string minLength: 1 bags: type: array description: List of bags to add items: $ref: '#/components/schemas/PassengerBagRequest' PassengerBagRequest: type: object additionalProperties: false required: - baggageTypeCode - baggageStatus - taggedToStation - weightType - weight properties: bagTag: type: string description: Bag tag, optional, automatically generated if left empty maxLength: 32 minLength: 0 nullable: true baggageTypeCode: type: string description: Baggage type code configurable in the environment minLength: 1 baggageStatus: $ref: '#/components/schemas/ProcessBaggageActionType' taggedToStation: type: string description: 'Last station of the bag''s journey. Used for long checking or short cheking when adding bags to multiple segments/journeys.' maxLength: 3 minLength: 3 weightType: description: Pounds or Kilograms (DAPI's weight type Default = Kilograms) $ref: '#/components/schemas/WeightType' weight: type: integer description: Weight of the bag format: int32 maximum: 9999.0 minimum: 0.0 ProcessBaggageActionType: type: integer description: '0 = Add 1 = CheckIn 2 = Print' x-enumNames: - Add - CheckIn - Print enum: - 0 - 1 - 2 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 BaggageAddRequestV3: type: object additionalProperties: false required: - segmentKey - passengerAlternateKey - bags properties: segmentKey: type: string minLength: 1 passengerAlternateKey: type: string description: Selected/target passenger to have an added/checked/printed bag. minLength: 1 bags: type: array description: List of bags to add items: $ref: '#/components/schemas/PassengerBagRequestV3' recordLocator: type: string description: Optional; if no record locator is provided, bags will be added to the booking in state. nullable: true otherSelectedPassengersAlternateKeys: type: array description: "List of alternate keys for other selected passengers being\ \ processed with the passenger getting his/her bag processed.\nThis list\ \ will be translated into empty bag requests which NS uses to evaluate\ \ baggage allowances \nand fees based on Multi-Passenger Baggage Group,\ \ Market Setting, Baggage Rules, etc.\nEmpty list would mean only the\ \ passenger getting bag processed is being evaluated by NS.\nThis list\ \ is ignored if record locator is provided." nullable: true items: type: string PassengerBagRequestV3: type: object additionalProperties: false required: - type - status - taggedToStation - weightType - weight properties: bagTag: type: string description: Bag tag, optional, automatically generated if left empty nullable: true type: type: string description: Baggage type code configurable in the environment minLength: 1 status: $ref: '#/components/schemas/ProcessBaggageActionType' taggedToStation: type: string description: 'Last station of the bag''s journey. Used for long checking or short cheking when adding bags to multiple segments/journeys.' maxLength: 3 minLength: 3 weightType: description: Pounds or Kilograms (DAPI's weight type Default = Kilograms) $ref: '#/components/schemas/WeightType' weight: type: integer description: Weight of the bag format: int32 maximum: 9999.0 minimum: 0.0 IJsonResponseOfBoardingClearanceResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/BoardingClearanceResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' BoardingClearanceResponse: type: object additionalProperties: false properties: something: type: array nullable: true items: type: string BoardingClearanceRequest: type: object additionalProperties: false required: - legKey - passengerAlternateKey - isResubmission properties: legKey: type: string minLength: 1 passengerAlternateKey: type: string minLength: 1 isResubmission: type: boolean countryCode: type: string nullable: true overrides: type: array nullable: true items: $ref: '#/components/schemas/BoardingClearanceOverride' BoardingClearanceOverride: type: object additionalProperties: false required: - legKey properties: legKey: type: string minLength: 1 isInfant: type: boolean appsDataType: $ref: '#/components/schemas/AppsOverrideDataType' appsData: type: string nullable: true governmentProgramType: $ref: '#/components/schemas/GovernmentProgramType' driverName: type: string nullable: true manualOverrideInfo: type: string nullable: true comment: type: string nullable: true AppsOverrideDataType: type: integer description: '0 = None 1 = DepartureOverride 2 = ArrivalOverride 3 = DepartureManualBoardingDirective 4 = ArrivalManualBoardingDirective' x-enumNames: - None - DepartureOverride - ArrivalOverride - DepartureManualBoardingDirective - ArrivalManualBoardingDirective enum: - 0 - 1 - 2 - 3 - 4 GovernmentProgramType: type: integer description: '0 = None 1 = Aqq 2 = SecureFlight 3 = Apps 4 = Apis 5 = Iapp 6 = Eub 7 = Iatci 8 = DocCheck 9 = DocsOnly 10 = Pnrgov 11 = DigiYatra 12 = Pfms' x-enumNames: - None - Aqq - SecureFlight - Apps - Apis - Iapp - Eub - Iatci - DocCheck - DocsOnly - Pnrgov - DigiYatra - Pfms enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 IJsonResponseOfString: type: object additionalProperties: false properties: data: type: string nullable: true errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' BoardingClearanceBatchRequest: type: object additionalProperties: false required: - legKey - filterType properties: legKey: type: string minLength: 1 filterType: $ref: '#/components/schemas/ManifestPassengerFilterType' countryCode: type: string nullable: true 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 IJsonResponseOfBgrCommandsResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/BgrCommandsResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' BgrCommandsResponse: type: object additionalProperties: false properties: disconnectCommands: type: array description: 'List of commands used to disconnect from the device. These commands are not tokenized.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' activateCommands: type: array description: 'List of commands used to put the device in a state where it can be actively used to board. These commands are not tokenized. Note that these commands do not support biometric boarding.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' deactivateCommands: type: array description: 'List of commands used to discontinue use of the device and disconnect from it. These commands are not tokenized.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' preBoardCommands: type: array description: 'List of commands used to prepare the device for boarding the next passenger. These commands are not tokenized. Note that some customers don''t use these commands, so if an empty list is returned, no commands should be sent to the device.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' postBoardSuccessTokenizedCommands: type: array description: 'List of tokenized commands used after a boarding request succeeded WITHOUT any warnings, and a receipt SHOULD NOT be printed. Supported tokens are %%FirstName%%, %%LastName%%, %%BoardingSequence%%, and %%UnitDesignator%%.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' postBoardSuccessAndPrintReceiptTokenizedCommands: type: array description: 'List of tokenized commands used after a boarding request succeeded WITHOUT any warnings, and a receipt SHOULD be printed. Note that receipts printed with these commands will not include a notification of any seat change. Supported tokens are %%FirstName%%, %%LastName%%, %%BoardingSequence%%, and %%UnitDesignator%%.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' postBoardSuccessWithWarningTokenizedCommands: type: array description: 'List of tokenized commands used after a boarding request succeeded WITH warnings, and a receipt SHOULD NOT be printed. Supported tokens are %%FirstName%%, %%LastName%%, %%BoardingSequence%%, and %%UnitDesignator%%.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' postBoardSuccessWithWarningAndPrintReceiptTokenizedCommands: type: array description: 'List of tokenized commands used after a boarding request succeeded WITH warnings, and a receipt SHOULD be printed. Note that receipts printed with these commands will not include a notification of any seat change. Supported tokens are %%FirstName%%, %%LastName%%, %%BoardingSequence%%, and %%UnitDesignator%%.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' postBoardVerificationTokenizedCommands: type: array description: 'List of tokenized commands used after a boarding request returned a verification code. This menas that the boarding was not performed, and an agent needs to verify the travel documents, after which he may override ESTA. Supported tokens are %%FirstName%%, %%LastName%%, %%BoardingSequence%%, and %%UnitDesignator%%.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' postBoardFailureTokenizedCommands: type: array description: 'List of tokenized commands used after a boarding request failed. Supported tokens are %%FirstName%%, %%LastName%%, %%BoardingSequence%%, %%UnitDesignator%%, and %%ErrorMessage%%.' nullable: true items: $ref: '#/components/schemas/DeviceCommand' DeviceCommand: type: object additionalProperties: false properties: mode: type: string description: The mode the data should be sent in. nullable: true originalData: type: string description: If the command has unprintable binary characters, this contains the binary command data. nullable: true sanitizedData: type: string description: 'This contains a printable version of the command data, which means that if the command has unprintable binary characters, the binary command data is in originalData.' nullable: true isBinary: type: boolean description: True if originalData has unprintable binary characters. mustCheckIfBusy: type: boolean description: True if an app should check if the device is busy before sending this command. mustRun: type: boolean description: True if this command must run, even when other commands fail. IJsonResponseOfListOfBookingSummary: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/BookingSummary' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' BookingSummary: type: object additionalProperties: false properties: bookingKey: type: string nullable: true allowedToModifyGdsBooking: type: boolean bookingStatus: $ref: '#/components/schemas/BookingStatus' channelType: $ref: '#/components/schemas/ChannelType' editable: type: boolean expiredDate: type: string format: date-time nullable: true flightDate: type: string format: date-time nullable: true flightNumber: type: string nullable: true origin: type: string nullable: true passengerId: type: integer format: int64 recordLocator: type: string nullable: true sourceAgentCode: type: string nullable: true sourceDomainCode: type: string nullable: true sourceOrganizationCode: type: string nullable: true systemCode: type: string nullable: true destination: type: string nullable: true name: nullable: true $ref: '#/components/schemas/Name' BookingStatus: type: integer description: '0 = Default 1 = Hold 2 = Confirmed 3 = Closed 4 = HoldCanceled 5 = PendingArchive 6 = Archived 7 = ArchivedPrivate 777 = ProcessedForArchive' x-enumNames: - Default - Hold - Confirmed - Closed - HoldCanceled - PendingArchive - Archived - ArchivedPrivate - ProcessedForArchive enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 777 ChannelType: type: integer description: 'Defines the available channel types invoking communication with the server. 0 = Default 1 = Direct 2 = Web 3 = Gds 4 = Api 5 = DigitalApi 6 = DigitalWeb 7 = Ndc' x-enumNames: - Default - Direct - Web - Gds - Api - DigitalApi - DigitalWeb - Ndc enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 Name: type: object additionalProperties: false properties: first: type: string nullable: true middle: type: string nullable: true last: type: string nullable: true title: type: string nullable: true suffix: type: string nullable: true SearchByScanRequestV2: type: object additionalProperties: false required: - scan properties: scan: $ref: '#/components/schemas/ParseScanRequestV2' origin: type: string maxLength: 3 minLength: 3 nullable: true departureDate: type: string format: date-time nullable: true ParseScanRequestV2: type: object additionalProperties: false properties: track1: type: string nullable: true track2: type: string nullable: true track3: type: string nullable: true locationCode: type: string description: 'The location code specifying which parsing rules will be used. If not specified, the default location code from the JWT will be used.' nullable: true documentTypeCode: type: string description: "This is only used when the scanned data is from a travel documment.\ \ If left blank\nwhen parsing a travel document's scanned data, the MRZ\ \ parser will try to guess \nwhich document type code to use." nullable: true IJsonResponseOfCheckinGeneralRequirementsResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/CheckinGeneralRequirementsResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' CheckinGeneralRequirementsResponse: type: object additionalProperties: false properties: isFulfilled: type: boolean passengerRequirements: type: array nullable: true items: $ref: '#/components/schemas/PassengerCheckinRequirements' bookingRestrictions: type: array nullable: true items: $ref: '#/components/schemas/CheckinGeneralRequirementType' PassengerCheckinRequirements: type: object additionalProperties: false properties: isFulfilled: type: boolean passengerKey: type: string nullable: true requirements: type: array nullable: true items: $ref: '#/components/schemas/GeneralRequirement' emdCouponRequirements: type: array nullable: true items: $ref: '#/components/schemas/EmdCouponRequirement' invalidPricingRequirements: type: array nullable: true items: $ref: '#/components/schemas/InvalidPricingRequirement' ticketRequirements: type: array nullable: true items: $ref: '#/components/schemas/TicketRequirement' GeneralRequirement: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinGeneralRequirementType' isFulfilled: type: boolean 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 EmdCouponRequirement: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinGeneralRequirementType' isFulfilled: type: boolean couponSourceSystemCode: type: string description: 'Code for the system that sent the EMD information. For example, this can be the booking source (GDS or marketing carrier) or an operating carrier that updated the booking. This can also be blank, for example, if added from Skyspeed. Examples: 1A - Amadeus, 1S - Sabre, etc...' nullable: true ssrCode: type: string nullable: true InvalidPricingRequirement: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinGeneralRequirementType' isFulfilled: type: boolean errorMessage: type: string nullable: true TicketRequirement: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinGeneralRequirementType' isFulfilled: type: boolean ticketNumber: type: string nullable: true isInfant: type: boolean CheckinGeneralRequirementsRequest: type: object additionalProperties: false required: - segmentKeys - passengerAlternateKeys properties: segmentKeys: type: array items: type: string passengerAlternateKeys: type: array items: type: string IJsonResponseOfCheckinSecurityRequirementsResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/CheckinSecurityRequirementsResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' CheckinSecurityRequirementsResponse: type: object additionalProperties: false properties: isFulfilled: type: boolean passengerRequirements: type: array nullable: true items: $ref: '#/components/schemas/PassengerSecurityRequirements' PassengerSecurityRequirements: type: object additionalProperties: false properties: isFulfilled: type: boolean passengerKey: type: string nullable: true isSelectee: type: boolean additionalDataRequirements: type: array nullable: true items: $ref: '#/components/schemas/AdditionalDataSecurityRequirement' addressRequirements: type: array nullable: true items: $ref: '#/components/schemas/AddressSecurityRequirement' documentRequirements: type: array nullable: true items: $ref: '#/components/schemas/DocumentSecurityRequirement' AdditionalDataSecurityRequirement: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinSecurityRequirementType' isFulfilled: type: boolean programDescription: type: string nullable: true errorText: type: string nullable: true governmentProgramType: type: string nullable: true driverName: type: string nullable: true securityValidation: $ref: '#/components/schemas/SecurityValidation' isInfantRequirement: type: boolean canHandle: type: boolean additionalDataFields: type: array nullable: true items: $ref: '#/components/schemas/GovernmentAdditionalDataType' allowCheckinOverride: type: boolean isOutageMode: type: boolean validOverrideResponseCodes: type: array nullable: true items: $ref: '#/components/schemas/ValidOverrideResponseCode' 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 SecurityValidation: type: integer description: '0 = Required 1 = Optional 2 = Suggested' x-enumNames: - Required - Optional - Suggested enum: - 0 - 1 - 2 GovernmentAdditionalDataType: type: integer description: '0 = CountryOfResidence 1 = InTransitAtOrigin 2 = InTransitAtDestination 3 = DateOfBirth 4 = Gender 5 = FirstName 6 = LastName 7 = StayType 8 = Nationality' x-enumNames: - CountryOfResidence - InTransitAtOrigin - InTransitAtDestination - DateOfBirth - Gender - FirstName - LastName - StayType - Nationality enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 ValidOverrideResponseCode: type: object additionalProperties: false properties: authStatusCode: type: string nullable: true authStatusDescription: type: string nullable: true AddressSecurityRequirement: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinSecurityRequirementType' isFulfilled: type: boolean programDescription: type: string nullable: true errorText: type: string nullable: true governmentProgramType: type: string nullable: true driverName: type: string nullable: true securityValidation: $ref: '#/components/schemas/SecurityValidation' isInfantRequirement: type: boolean canHandle: type: boolean destinationAddressStation: type: string nullable: true destinationAddressFields: type: array nullable: true items: type: string DocumentSecurityRequirement: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinSecurityRequirementType' isFulfilled: type: boolean programDescription: type: string nullable: true errorText: type: string nullable: true governmentProgramType: type: string nullable: true driverName: type: string nullable: true securityValidation: $ref: '#/components/schemas/SecurityValidation' isInfantRequirement: type: boolean canHandle: type: boolean maxVerifiedDocuments: type: integer format: int32 minDocumentsRequired: type: integer format: int32 documentTypeRequirements: type: array nullable: true items: $ref: '#/components/schemas/DocumentTypeRequirement' requiresVerification: type: boolean requiresPrimaryDocument: type: boolean addedDocumentTypeCodes: type: array nullable: true items: type: string DocumentTypeRequirement: type: object additionalProperties: false properties: documentTypeCode: type: string nullable: true documentType: type: string nullable: true isActive: type: boolean documentTypeName: type: string nullable: true requiredFields: type: array nullable: true items: $ref: '#/components/schemas/GovernmentDocumentFieldType' isPrimary: type: boolean GovernmentDocumentFieldType: type: integer description: '0 = FirstName 1 = MiddleName 2 = LastName 3 = Title 4 = Suffix 5 = DateOfBirth 6 = BirthCountry 7 = Gender 8 = Nationality 9 = Number 10 = IssuingCountry 11 = ExpirationDate 12 = IssuedDate 13 = Verified' x-enumNames: - FirstName - MiddleName - LastName - Title - Suffix - DateOfBirth - BirthCountry - Gender - Nationality - Number - IssuingCountry - ExpirationDate - IssuedDate - Verified enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 CheckinSecurityRequirementsRequest: type: object additionalProperties: false required: - segmentKeys - passengers properties: segmentKeys: type: array items: type: string passengers: type: array items: $ref: '#/components/schemas/CheckinRequestPassenger' CheckinRequestPassenger: type: object additionalProperties: false required: - passengerAlternateKey properties: passengerAlternateKey: type: string minLength: 1 verifiedTravelDocumentKeys: type: array nullable: true items: type: string inTransitAtOrigin: $ref: '#/components/schemas/NullableFlag' inTransitAtDestination: $ref: '#/components/schemas/NullableFlag' infantInTransitAtOrigin: $ref: '#/components/schemas/NullableFlag' infantInTransitAtDestination: $ref: '#/components/schemas/NullableFlag' overrides: type: array nullable: true items: $ref: '#/components/schemas/CheckinOverrideRequest' NullableFlag: type: integer description: '0 = Unknown 1 = True 2 = False' x-enumNames: - Unknown - 'True' - 'False' enum: - 0 - 1 - 2 CheckinOverrideRequest: type: object additionalProperties: false properties: code: type: string nullable: true governmentProgramType: $ref: '#/components/schemas/GovernmentProgramType' driverName: type: string nullable: true isDepartureClearance: type: boolean additionalData: type: array nullable: true items: $ref: '#/components/schemas/CheckinOverrideAdditionalData' isInfant: type: boolean CheckinOverrideAdditionalData: type: object additionalProperties: false properties: type: $ref: '#/components/schemas/CheckinOverrideAdditionalDataType' data: type: string nullable: true CheckinOverrideAdditionalDataType: type: integer description: '0 = Comment 1 = PassengerId' x-enumNames: - Comment - PassengerId enum: - 0 - 1 IJsonResponseOfListOfCheckinStepCustomRequirements: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/CheckinStepCustomRequirements' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' CheckinStepCustomRequirements: type: object additionalProperties: false properties: step: $ref: '#/components/schemas/CheckinStep' actionRequired: type: boolean visitRequired: 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 IJsonResponseOfCheckinResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/CheckinResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' CheckinResponse: type: object additionalProperties: false properties: passengers: type: array nullable: true items: $ref: '#/components/schemas/CheckinPassengerResponse' CheckinPassengerResponse: type: object additionalProperties: false properties: passengerAlternateKey: type: string nullable: true successfulSegments: type: array nullable: true items: $ref: '#/components/schemas/SegmentWithWarnings' failedSegments: type: array nullable: true items: $ref: '#/components/schemas/SegmentWithErrors' SegmentWithWarnings: type: object additionalProperties: false properties: segmentKey: type: string nullable: true warnings: type: array nullable: true items: type: string securityInfo: type: array nullable: true items: $ref: '#/components/schemas/CheckinSecurityInfo' iatciMessages: type: array nullable: true items: $ref: '#/components/schemas/CheckinIatciMessage' CheckinSecurityInfo: type: object additionalProperties: false properties: message: type: string nullable: true isInfant: type: boolean isError: type: boolean CheckinIatciMessage: type: object additionalProperties: false properties: type: $ref: '#/components/schemas/IatciMessageType' reason: type: string nullable: true segmentKey: type: string nullable: true IatciMessageType: type: integer description: '0 = PassengerLevelWarning 1 = FlightLevelWarning 2 = Error 3 = Success' x-enumNames: - PassengerLevelWarning - FlightLevelWarning - Error - Success enum: - 0 - 1 - 2 - 3 SegmentWithErrors: type: object additionalProperties: false properties: segmentKey: type: string nullable: true warnings: type: array nullable: true items: type: string securityInfo: type: array nullable: true items: $ref: '#/components/schemas/CheckinSecurityInfo' iatciMessages: type: array nullable: true items: $ref: '#/components/schemas/CheckinIatciMessage' errors: type: array nullable: true items: $ref: '#/components/schemas/Error' overrides: type: array nullable: true items: $ref: '#/components/schemas/CheckinOverrideResponse' Error: type: object additionalProperties: false properties: code: type: string description: The Error Code. nullable: true message: type: string description: The Error Message. nullable: true rawMessage: type: string description: The Raw Error Message. nullable: true CheckinOverrideResponse: type: object additionalProperties: false properties: overrideDetails: type: array nullable: true items: $ref: '#/components/schemas/CheckinOverrideDetails' governmentProgramType: $ref: '#/components/schemas/GovernmentProgramType' driverName: type: string nullable: true programDescription: type: string nullable: true isDepartureClearance: type: boolean message: type: string nullable: true additionalData: type: array nullable: true items: $ref: '#/components/schemas/CheckinOverrideAdditionalDataType' isInfant: type: boolean serverIsInOutageMode: type: boolean clearanceStatus: type: string nullable: true originatingCountryCode: type: string nullable: true CheckinOverrideDetails: type: object additionalProperties: false properties: code: type: string nullable: true description: type: string nullable: true CheckinRequest: type: object additionalProperties: false required: - recordLocator - segmentKeys - passengers properties: recordLocator: type: string minLength: 1 segmentKeys: type: array items: type: string passengers: type: array items: $ref: '#/components/schemas/CheckinRequestPassenger' requireSeats: type: boolean skipSecurityChecks: type: boolean description: "The flag indicating whether checkin requirement validation\ \ will be skipped.\n " UndoCheckinRequest: type: object additionalProperties: false required: - recordLocator - segmentKeys - passengers properties: recordLocator: type: string minLength: 1 segmentKeys: type: array description: An ordered list of the segments from which to uncheck the passengers. items: type: string passengers: type: array items: $ref: '#/components/schemas/UndoCheckinRequestPassenger' fromStationCode: type: string description: 'Specifies the starting point from which to uncheck the passengers. If left blank, the passengers will be unchecked from every leg in the specified segments.' nullable: true UndoCheckinRequestPassenger: type: object additionalProperties: false required: - passengerAlternateKey properties: passengerAlternateKey: type: string minLength: 1 verifiedTravelDocumentKeys: type: array nullable: true items: type: string IJsonResponseOfDeviceManagerInfo: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/DeviceManagerInfo' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' DeviceManagerInfo: type: object additionalProperties: false properties: deviceManagerKey: type: string nullable: true version: type: string nullable: true port: type: string nullable: true workstationName: type: string nullable: true devices: type: array nullable: true items: $ref: '#/components/schemas/ExternalDevice' connectionId: type: string nullable: true ExternalDevice: type: object additionalProperties: false properties: name: type: string description: The name of the device. nullable: true generalType: description: The general type of the device. $ref: '#/components/schemas/ExternalDeviceGeneralType' specificType: type: string description: 'The specific type of the device. Populate using Navitaire.Dcs.Contract.ExternalDevice.Constants.SpecificExternalDeviceType.' nullable: true commonUseProvider: type: string description: The specific common use provider of the device. nullable: true properties: type: array description: 'A list of properties associated with this device. The properties can either be system controlled or user controlled.' nullable: true items: $ref: '#/components/schemas/DeviceProperty' language: type: string description: 'The language of this device. Use constant file DeviceLanguage to populate this field.' nullable: true ExternalDeviceGeneralType: type: integer description: '0 = Unknown 1 = Printer 2 = Scanner 3 = BoardingGateReader 4 = SelfBoardingGate' x-enumNames: - Unknown - Printer - Scanner - BoardingGateReader - SelfBoardingGate enum: - 0 - 1 - 2 - 3 - 4 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 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 IJsonResponseOfListOfDisruptionFromLeg: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/DisruptionFromLeg' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' DisruptionFromLeg: type: object additionalProperties: false properties: operatingCarrierCode: type: string nullable: true operatingFlightNumber: type: string nullable: true operatingOpSuffix: type: string nullable: true operatedByText: type: string nullable: true departureTimeVariant: type: integer description: The leg departure local time variant in minutes. arrivalTimeVariant: type: integer description: The leg arrival local time variant in minutes. legKey: type: string nullable: true manifestLegKey: type: string nullable: true carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time status: $ref: '#/components/schemas/LegStatus' isIrop: type: boolean LegStatus: type: integer description: '0 = Blocked 1 = Boarding 2 = BoardingClosedPending 3 = Canceled 4 = Delayed 5 = Departed 6 = DepartedClosed 7 = DepartedClosedPending 8 = OnTime 9 = Closed 10 = OnTimeClosedPending 11 = Early 12 = Suspended 13 = EarlyClosedPending 14 = DelayedClosedPending' x-enumNames: - Blocked - Boarding - BoardingClosedPending - Canceled - Delayed - Departed - DepartedClosed - DepartedClosedPending - OnTime - Closed - OnTimeClosedPending - Early - Suspended - EarlyClosedPending - DelayedClosedPending enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 IJsonResponseOfListOfDisruptionFinalDestinationJourney: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/DisruptionFinalDestinationJourney' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' DisruptionFinalDestinationJourney: type: object additionalProperties: false properties: journeyKey: type: string nullable: true passengers: type: array nullable: true items: $ref: '#/components/schemas/DisruptionPassenger' segments: type: array nullable: true items: $ref: '#/components/schemas/DisruptionFinalDestinationSegment' DisruptionPassenger: type: object additionalProperties: false properties: status: $ref: '#/components/schemas/SegmentStatus' seat: type: string nullable: true fareClass: type: string nullable: true passengerCount: type: integer description: The Number of passengers in the booking. priorityCode: type: string nullable: true guestRecognitionValue: type: integer format: int32 name: nullable: true $ref: '#/components/schemas/Name' passengerNumber: type: integer description: The Passenger's number based on their order in the booking. recordLocator: type: string nullable: true SegmentStatus: type: integer description: 'The list of IATA standard booking action codes. These codes speicfy a requested GDS action or the current status of a passenger''s segment. 0 = AddToWaitList 1 = CancelDeclined 2 = CancelFailed 3 = Cancelled 4 = CancelUnconfirmed 5 = ClaimSpace 6 = Confirming 7 = ConfirmingNoAction 8 = ConfirmingUnheld 9 = ConfirmingWaitList 10 = DirectLinkConfirmed 11 = HeldCancelled 12 = HeldConfirmed 13 = HeldPending 14 = HeldUnconfirmed 15 = HoldingNeed 16 = NeedSpace 17 = NeedSpaceUnheld 18 = NoAction 19 = NoActionTaken 20 = OversellSpace 21 = Update 22 = UpdateConfirming 23 = WaitListConfirmed' x-enumNames: - AddToWaitList - CancelDeclined - CancelFailed - Cancelled - CancelUnconfirmed - ClaimSpace - Confirming - ConfirmingNoAction - ConfirmingUnheld - ConfirmingWaitList - DirectLinkConfirmed - HeldCancelled - HeldConfirmed - HeldPending - HeldUnconfirmed - HoldingNeed - NeedSpace - NeedSpaceUnheld - NoAction - NoActionTaken - OversellSpace - Update - UpdateConfirming - WaitListConfirmed 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 DisruptionFinalDestinationSegment: type: object additionalProperties: false properties: operatingCarrierCode: type: string nullable: true operatingFlightNumber: type: string nullable: true operatingOpSuffix: type: string nullable: true segmentType: $ref: '#/components/schemas/SegmentType' availabilitySourceCode: type: string nullable: true segmentKey: type: string nullable: true carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time legs: type: array nullable: true items: $ref: '#/components/schemas/LegInfo' SegmentType: type: integer description: '0 = Normal 1 = CodeShareOperating 2 = CodeShareMarketing 3 = InterlineOutbound 4 = InterlineInbound 5 = Passive 6 = NdcInterline' x-enumNames: - Normal - CodeShareOperating - CodeShareMarketing - InterlineOutbound - InterlineInbound - Passive - NdcInterline enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 LegInfo: type: object additionalProperties: false properties: carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time legKey: type: string nullable: true manifestLegKey: type: string nullable: true IJsonResponseOfListOfDisruptionToJourney: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/DisruptionToJourney' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' DisruptionToJourney: type: object additionalProperties: false properties: journeyKey: type: string nullable: true segments: type: array nullable: true items: $ref: '#/components/schemas/DisruptionToSegment' DisruptionToSegment: type: object additionalProperties: false properties: operatingCarrierCode: type: string nullable: true operatingFlightNumber: type: string nullable: true operatingOpSuffix: type: string nullable: true segmentType: $ref: '#/components/schemas/SegmentType' availabilitySourceCode: type: string nullable: true segmentKey: type: string nullable: true carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time legs: type: array nullable: true items: $ref: '#/components/schemas/DisruptionToLeg' DisruptionToLeg: type: object additionalProperties: false properties: operatingCarrierCode: type: string nullable: true operatingFlightNumber: type: string nullable: true operatingOpSuffix: type: string nullable: true operatedByText: type: string nullable: true departureTimeVariant: type: integer description: The leg departure local time variant in minutes. arrivalTimeVariant: type: integer description: The leg arrival local time variant in minutes. legKey: type: string nullable: true manifestLegKey: type: string nullable: true carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time status: $ref: '#/components/schemas/ToLegStatus' nests: type: array nullable: true items: $ref: '#/components/schemas/DisruptionToLegNest' ToLegStatus: type: integer description: 'Subset of LegStatus enum for use in searches that filter to only return results with LegStatus of OnTime or OnTimeClosedPending. 8 = OnTime 10 = OnTimeClosedPending' x-enumNames: - OnTime - OnTimeClosedPending enum: - 8 - 10 DisruptionToLegNest: type: object additionalProperties: false properties: lid: type: integer description: Maximum number of seats authorized to be sold on a nest. sold: type: integer description: The number of seats sold in this nest. cabinOfService: type: string description: The value of the cabin travel class for this nest. maxLength: 1 FlightType: type: integer description: '0 = All 1 = NonStop 2 = Through 3 = Direct 4 = Connect' x-enumNames: - All - NonStop - Through - Direct - Connect enum: - 0 - 1 - 2 - 3 - 4 IJsonResponseOfDisruptionCombinedJourney: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/DisruptionCombinedJourney' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' DisruptionCombinedJourney: type: object additionalProperties: false properties: journeyKey: type: string nullable: true containsAdHocConnection: type: boolean segments: type: array nullable: true items: $ref: '#/components/schemas/DisruptionCombinedSegment' DisruptionCombinedSegment: type: object additionalProperties: false properties: operatingCarrierCode: type: string nullable: true operatingFlightNumber: type: string nullable: true operatingOpSuffix: type: string nullable: true segmentType: $ref: '#/components/schemas/SegmentType' availabilitySourceCode: type: string nullable: true segmentKey: type: string nullable: true carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time legKeys: type: array nullable: true items: type: string SegmentKeyInfo: type: object additionalProperties: false required: - segmentKey - legKeys properties: segmentKey: type: string minLength: 1 legKeys: type: array items: type: string IJsonResponseOfDisruptionMoveResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/DisruptionMoveResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' DisruptionMoveResponse: type: object additionalProperties: false properties: successfulRecordLocators: type: array description: List of record locators for the bookings whose passengers were successfully moved. nullable: true items: type: string failedRecordLocators: type: array description: 'List of record locators for the bookings whose passengers were NOT moved, including the associated error that prevented the move. Note: There is one error per failed record locator.' nullable: true items: $ref: '#/components/schemas/DisruptionMoveError' DisruptionMoveError: type: object additionalProperties: false properties: recordLocator: type: string nullable: true errorCode: type: string nullable: true message: type: string nullable: true DisruptionMoveRequest: type: object additionalProperties: false required: - fromJourneyKey - toJourneyKey - toJourneyIsNotForGeneralUse - moveType - recordLocators - inventoryControlType properties: fromJourneyKey: type: string minLength: 1 toJourneyKey: type: string minLength: 1 toJourneyIsNotForGeneralUse: type: boolean moveType: description: Specifies whether this disruption move is an IROP or a diversion. $ref: '#/components/schemas/DisruptionMoveType' diversionBoardingSequenceOffSet: type: integer description: 'In a diversion move (i.e. when MoveType == 1) the boarding sequence values of the from-journey segments are copied to the to-journey segments and then incremented by the specified DiversionBoardingSequenceOffSet. In an IROP move (i.e. when MoveType == 0), DiversionBoardingSequenceOffSet is not used.' maximum: 9999.0 minimum: 0.0 recordLocators: type: array items: type: string inventoryControlType: description: "Use DisruptionInventoryControlType.ClaimSpace\n-\tWhen changing\ \ HL to HK and overselling is not intended\n-\tRetaining HK pax and overselling\ \ is not intended\n\nUse DisruptionInventoryControlType.OversellSpace\n\ -\tOnly when passenger is going to claim space on the to flight\n-\tIf\ \ passenger is for wait list, no need to oversell\n\nUse DisruptionInventoryControlType.StandBy\n\ -\tWhen changing status from HK to HL\n-\tRetaining HL pax" $ref: '#/components/schemas/DisruptionInventoryControlType' standByPriorityCode: type: string nullable: true isChangeOfStatus: type: boolean DisruptionMoveType: type: integer description: 'Defines the different types of disruption moves. 0 = Irop 1 = Diversion' x-enumNames: - Irop - Diversion enum: - 0 - 1 DisruptionInventoryControlType: type: integer description: 'Defines the different ways inventory can be requested during a disruption move. 0 = ClaimSpace 1 = OversellSpace 2 = StandBy' x-enumNames: - ClaimSpace - OversellSpace - StandBy enum: - 0 - 1 - 2 ScannedDocumentRequest: type: object additionalProperties: false required: - passengerKey - scan properties: passengerKey: type: string minLength: 1 isInfant: type: boolean scan: $ref: '#/components/schemas/ParseScanRequestV2' VerifyScannedDocumentsRequest: type: object deprecated: true x-deprecatedMessage: This will be removed once all customers are off of Navitaire Kiosk 2.2. additionalProperties: false required: - scannedDocuments properties: scannedDocuments: type: array items: $ref: '#/components/schemas/VerifyScannedDocumentRequest' VerifyScannedDocumentRequest: type: object deprecated: true x-deprecatedMessage: This will be removed once all customers are off of Navitaire Kiosk 2.2. additionalProperties: false required: - scan - travelDocumentKey properties: scan: $ref: '#/components/schemas/ParseScanRequest' travelDocumentKey: type: string minLength: 1 ParseScanRequest: type: object deprecated: true x-deprecatedMessage: This will be removed once all customers are off of Navitaire Kiosk 2.2. additionalProperties: false properties: track1: type: string nullable: true track2: type: string nullable: true track3: type: string nullable: true location: type: string nullable: true documentTypeCode: type: string description: "This is only used when the scanned data is from a travel documment.\ \ If left blank\nwhen parsing a travel document's scanned data, the MRZ\ \ parser will try to guess \nwhich document type code to use." nullable: true IJsonResponseOfEnvironmentHealth: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/EnvironmentHealth' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' EnvironmentHealth: type: object additionalProperties: false properties: component: type: string nullable: true componentType: type: string nullable: true details: type: string nullable: true status: $ref: '#/components/schemas/HealthStatus' nodes: type: array nullable: true items: $ref: '#/components/schemas/HealthInformation' HealthStatus: type: integer description: '0 = Unknown 1 = Ok 2 = Warning 3 = Error' x-enumNames: - Unknown - Ok - Warning - Error enum: - 0 - 1 - 2 - 3 HealthInformation: type: object additionalProperties: false properties: component: type: string nullable: true componentType: type: string nullable: true details: type: string nullable: true status: $ref: '#/components/schemas/HealthStatus' IJsonResponseOfListOfString: type: object additionalProperties: false properties: data: type: array nullable: true items: type: string errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfTokenResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/TokenResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' TokenResponse: type: object additionalProperties: false properties: token: type: string nullable: true idleTimeoutInMinutes: type: integer format: int32 TokenRequest: type: object additionalProperties: false properties: applicationName: type: string nullable: true GraphQlQuery: type: object additionalProperties: false required: - query properties: query: type: string minLength: 1 variables: type: string nullable: true cachedResults: type: boolean name: type: string nullable: true IJsonResponseOfObject: type: object additionalProperties: false properties: data: nullable: true errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' GraphQlQueryv2: type: object additionalProperties: false required: - query properties: query: type: string minLength: 1 variables: nullable: true cachedResults: type: boolean IJsonResponseOfListOfLeg: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/Leg' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' Leg: type: object additionalProperties: false properties: legKey: type: string nullable: true manifestLegKey: type: string nullable: true carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time codeShareIndicator: $ref: '#/components/schemas/CodeShareIndicator' operatingCarrierCode: type: string nullable: true operatingFlightNumber: type: string nullable: true operatingOpSuffix: type: string nullable: true status: $ref: '#/components/schemas/LegStatus' estimatedDepartureGate: type: string nullable: true actualDepartureGate: type: string nullable: true isVerified: type: boolean capacityCount: type: integer description: The capacity of the aircraft/equipment. format: int32 soldCount: type: integer description: The number of seats sold. format: int32 checkedInCount: type: integer description: The number of passengers that have checked in. format: int32 boardedCount: type: integer description: The number of passengers that have boarded. format: int32 noShowCount: type: integer description: The number of passengers that have not checked in. format: int32 CodeShareIndicator: type: integer description: 'Specifies the type of code share agreement. 0 = NonCodeShare 1 = CodeShareCommercialDuplicate 2 = SharedDesignatorOrWetLease 3 = CodeShareHostOperatingCarrier 4 = CodeShareCommercialDuplicateWithOverrideText 5 = SharedDesignatorOrWetLeaseWithOverrideText' x-enumNames: - NonCodeShare - CodeShareCommercialDuplicate - SharedDesignatorOrWetLease - CodeShareHostOperatingCarrier - CodeShareCommercialDuplicateWithOverrideText - SharedDesignatorOrWetLeaseWithOverrideText enum: - 0 - 1 - 2 - 3 - 4 - 5 IJsonResponseOfListOfLegEquipment: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/LegEquipment' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' LegEquipment: type: object deprecated: true x-deprecatedMessage: This will be removed when the GoNow Thin Client is finished if no one is using it yet. additionalProperties: false properties: legKey: type: string nullable: true manifestLegKey: type: string nullable: true carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time equipmentType: type: string nullable: true equipmentTypeSuffix: type: string nullable: true tailNumber: type: string nullable: true IJsonResponseOfOperationsInfo: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/OperationsInfo' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' OperationsInfo: type: object additionalProperties: false properties: legKey: type: string nullable: true manifestLegKey: type: string nullable: true carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time isPassive: type: boolean description: "Specifies whether this leg belongs to a passive segment.\n\ \ " status: description: "The calculated status of the flight.\n " $ref: '#/components/schemas/LegStatus' departureStatus: description: "Represents the departure status.\n " $ref: '#/components/schemas/DepartureStatus' departureNote: type: string description: "Represents additional information about the\ntrip operation\ \ station.\n " nullable: true estimatedDepartureGate: type: string description: "Represents the gate details.\n " nullable: true actualDepartureGate: type: string description: "Represents the actual gate of the trip mode.\n " nullable: true arrivalStatus: description: "Represents the arrival status.\n " $ref: '#/components/schemas/ArrivalStatus' arrivalNote: type: string description: "Represents additional information about the\ntrip operation\ \ station.\n " nullable: true estimatedArrivalGate: type: string description: "Represents the gate details.\n " nullable: true actualArrivalGate: type: string description: "Represents the actual gate of the trip mode.\n " nullable: true baggageClaim: type: string description: "Represents the airline defined location where the trip's\n\ luggage is to be retrieved.\n " nullable: true operationalTimes: description: "List of operational times.\n " nullable: true $ref: '#/components/schemas/OperationalTimes' tailNumber: type: string description: "Represents the tail number for the aircraft.\n " nullable: true equipmentType: type: string description: "Represents the equipment type for the leg.\n " nullable: true equipmentTypeSuffix: type: string description: "Represents the equipment type suffix for the leg.\n \ \ " nullable: true modifiedAgentName: type: string description: "The name of the agent that last modified this data.\n \ \ " nullable: true isVerified: type: boolean description: "Represents the verified bit.\n " isIrop: type: boolean description: "Represents the IROP flag.\n " operationCounts: description: "Represents the various counts related to the operation.\n\ \ " nullable: true $ref: '#/components/schemas/OperationCounts' comments: type: array description: "Represents the comments related to this trip operation.\n\ \ " nullable: true items: $ref: '#/components/schemas/OperationComment' delays: type: array description: "A list of trip operation delays.\n " nullable: true items: $ref: '#/components/schemas/OperationDelay' payloads: type: array description: "Represents the list of trip operation payloads.\n \ \ " nullable: true items: $ref: '#/components/schemas/OperationPayload' crewList: type: array description: "Represents the list of crew members.\n " nullable: true items: $ref: '#/components/schemas/OperationCrew' historyList: type: array description: "Represents the history of this trip operation.\n \ \ " nullable: true items: $ref: '#/components/schemas/OperationHistory' boardingTimeOffset: type: integer description: "Represents the number of minutes before a flight departs that\ \ boarding is scheduled to begin. \n " DepartureStatus: type: integer description: '0 = Default 1 = Cancelled 2 = Boarding 3 = SeeAgent 4 = Delayed 5 = Departed' x-enumNames: - Default - Cancelled - Boarding - SeeAgent - Delayed - Departed enum: - 0 - 1 - 2 - 3 - 4 - 5 ArrivalStatus: type: integer description: '0 = Default 1 = Cancelled 2 = Arrived 3 = SeeAgent 4 = Delayed' x-enumNames: - Default - Cancelled - Arrived - SeeAgent - Delayed enum: - 0 - 1 - 2 - 3 - 4 OperationalTimes: type: object additionalProperties: false properties: estimatedTouchDownTime: type: string description: "Represents the estimated touch down time.\n " format: date-time nullable: true actualTouchDownTime: type: string description: "Represents the actual touch down time.\n " format: date-time nullable: true forcedTouchDownTime: type: string description: "Represents the forced touch down time.\n " format: date-time nullable: true estimatedOnBlockTime: type: string description: "Represents the estimated on block time.\n " format: date-time nullable: true actualOnBlockTime: type: string description: "Represents the actual on block time.\n " format: date-time nullable: true forcedOnBlockTime: type: string description: "Represents the forced on block time.\n " format: date-time nullable: true estimatedDepartureTime: type: string description: "Represents the estimated departure time.\n " format: date-time nullable: true offBlockTime: type: string description: "Represents the off-block time for this flight operation.\n\ \ " format: date-time nullable: true airborneTime: type: string description: "Represents the airborne time for this flight operation.\n\ \ " format: date-time nullable: true crewReportTime: type: string description: "Represents the crew report time for this flight operation.\n\ \ " format: date-time nullable: true takeOffTime: type: string description: "Represents the take-off time for this flight operation.\n\ \ " format: date-time nullable: true movementAfterPushBackTime: type: string description: "Represents the movement after push-back time (taxi) for this\ \ flight operation.\n " format: date-time nullable: true nextInformationTime: type: string description: "Represents the next information time for this flight operation.\n\ \ " format: date-time nullable: true reclearanceTime: type: string description: "Represents the re-clearance time for this flight operation.\n\ \ " format: date-time nullable: true returnToRampTime: type: string description: "Represents the return to ramp time for this flight operation.\n\ \ " format: date-time nullable: true OperationCounts: type: object additionalProperties: false properties: capacityCount: type: integer description: 'The number of passengers that can be seated in the aircraft. This does not include cabin crew or cockpit crew.' format: int32 soldCount: type: integer description: The number of seats sold. format: int32 nonRevenueCount: type: integer description: The number of non-revenue passengers. revenueCount: type: integer description: The number of revenue passengers. infantCount: type: integer description: The number of infants not occupying a seat. checkInCount: type: integer description: 'The number of passengers that have checked in. This value is called CheckedInCount in the response of GET api/dcs/v1/legs.' noShowCount: type: integer description: The number of passengers that have not checked in. format: int32 boardingCount: type: integer description: 'The number of passengers that have boarded. This value is called BoardedCount in the response of GET api/dcs/v1/legs.' boardingSequence: type: integer description: The last boarding sequence number used for a passenger on this leg. fuelOnboardOut: type: integer description: The amount of fuel onboard the aircraft upon departure. format: int32 fuelOnboardIn: type: integer description: The amount of fuel onboard the aircraft upon arrival. format: int32 upliftFuel: type: integer description: The amount of fuel loaded onto the aircraft before takeoff. format: int32 upliftWeight: type: integer description: The weight of fuel loaded onto the aircraft before takeoff. format: int32 cockpitCrewCount: type: integer description: The number of crew in the cockpit. cabinCrewCount: type: integer description: The number of crew in the cabin. OperationComment: type: object additionalProperties: false properties: commentKey: type: string description: "The unique identification number for the comment.\n \ \ " nullable: true text: type: string description: "Represents the comment text.\n " nullable: true type: description: "Represents the comment type.\n " $ref: '#/components/schemas/OperationCommentType' createdDate: type: string description: "Represents the datetime (UTC) of when the comment was created.\n\ \ " format: date-time modifiedDate: type: string description: "Represents the datetime (UTC) of when the comment was last\ \ modified.\n " format: date-time OperationCommentType: type: integer description: "The operation comment type enumeration.\n \n\n0 = Default\n\ 1 = Reservation\n2 = Operation\n3 = PitLoad\n4 = Irop\n5 = AppsOverride\n\ 6 = ManualAppsOverride" x-enumNames: - Default - Reservation - Operation - PitLoad - Irop - AppsOverride - ManualAppsOverride enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 OperationDelay: type: object additionalProperties: false properties: delayKey: type: string description: "The unique identification for the trip operation delay.\n\ \ " nullable: true createdDate: type: string description: "The date the status was created.\n " format: date-time nullable: true code: type: string description: "The delay code.\n " nullable: true minutes: type: integer description: "The number of minutes for this delay.\n " note: type: string description: "The note for this delay, containing extra information about\ \ the delay\n(if any).\n " nullable: true includeMvtMessage: type: boolean description: "The flag to include the MVT message.\n " OperationPayload: type: object additionalProperties: false properties: type: type: string description: "The type of payload this model represents, expressed as a\ \ single\ncharacter.\nPlease note that this should be a char and not a\ \ string.\n " maxLength: 1 nullable: true compartment: type: string description: "The compartment for the payload this model represents, expressed\n\ as a single character.\nPlease note that this should be a char and not\ \ a string.\n " maxLength: 1 nullable: true count: type: integer description: "The payload count.\n " format: int32 weight: type: integer description: "The total payload weight.\n " format: int32 OperationCrew: type: object additionalProperties: false properties: crewKey: type: string description: "The unique identifier for the trip crew operation.\n \ \ " nullable: true type: description: "The crew personnel type.\n " $ref: '#/components/schemas/CrewType' CrewType: type: integer description: "Defines the different types of crew members.\n \n\n\ 0 = Default\n1 = Pilot\n2 = CoPilot\n3 = CockpitJumpseat\n4 = CabinJumpseat\n\ 5 = CabinCrew" x-enumNames: - Default - Pilot - CoPilot - CockpitJumpseat - CabinJumpseat - CabinCrew enum: - 0 - 1 - 2 - 3 - 4 - 5 OperationHistory: type: object additionalProperties: false properties: historyKey: type: string description: "The unique identification for the trip operation history.\n\ \ " nullable: true code: type: string description: "Represents the code for the event that triggered an entry\ \ into history.\n " nullable: true detail: type: string description: "Represents the history details.\n " nullable: true createdDate: type: string description: "The date when this history item was created.\n " format: date-time nullable: true IJsonResponseOfListOfLegInfo: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/LegInfo' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfListOfLegCloseSecurityRequirement: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/LegCloseSecurityRequirement' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' LegCloseSecurityRequirement: type: object additionalProperties: false properties: governmentProgram: type: string description: The name of the government program. nullable: true governmentProgramType: description: The type of the government program. $ref: '#/components/schemas/GovernmentProgramType' programDescription: type: string description: A description of the government program. nullable: true eligibleDocuments: type: array description: 'A list of documents that are eligible for satisfying the goverment program. ' nullable: true items: $ref: '#/components/schemas/DocumentRequirement' documentRequiredFields: type: array description: 'A list of document fields that are required for a document to contain in order to satisfy the government program. ' nullable: true items: $ref: '#/components/schemas/GovernmentDocumentFieldType' additionalDataRequiredFields: type: array description: 'A list of additional data fields that are required to satisfy the government program. ' nullable: true items: $ref: '#/components/schemas/GovernmentAdditionalDataType' minVerifiedDocumentCount: type: integer description: 'The minimum amount of eligible documents needed to safisty the government program. ' format: int32 flightCloseCountryCodes: type: array description: 'The list of country codes in which the government program requirement applies. More information on a given country code can be found via GET /api/nsk/v2/resources/countries/{countryCode} ' nullable: true items: type: string DocumentRequirement: type: object additionalProperties: false properties: typeCode: type: string description: The type code of the document nullable: true group: description: 'Corresponds to what NewSkies calls the DocumentType (which is different from the DocumentTypeCode).' $ref: '#/components/schemas/DocumentGroup' typeName: type: string description: The type name of the document nullable: true isPrimary: type: boolean description: Whether or not the document can be considered a primary document. DocumentGroup: type: integer description: 'Corresponds to what NewSkies calls the DocumentType (which is different from the DocumentTypeCode). 0 = Unknown 1 = AlienRegistrationCard 2 = PermanentResidentCard 3 = FacilitationDocument 4 = InsPass 5 = MilitaryId 6 = Passport 7 = ReEntryPermit 8 = CreditCard 9 = TravelVisa 10 = OAFrequentFlyer 11 = ParoleLetter 12 = NoticeOfAction 13 = TransportationLetter 14 = BorderCrossingCard 15 = PilotLicense 16 = USNaturalizationCertificate 17 = RefugeeTravelDocument 18 = GovernmentId 19 = DriversLicense 20 = RedressNumber 21 = KnownTravelerId 22 = FormOfId 23 = Nexus 24 = SecondaryExempt' x-enumNames: - Unknown - AlienRegistrationCard - PermanentResidentCard - FacilitationDocument - InsPass - MilitaryId - Passport - ReEntryPermit - CreditCard - TravelVisa - OAFrequentFlyer - ParoleLetter - NoticeOfAction - TransportationLetter - BorderCrossingCard - PilotLicense - USNaturalizationCertificate - RefugeeTravelDocument - GovernmentId - DriversLicense - RedressNumber - KnownTravelerId - FormOfId - Nexus - SecondaryExempt 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 LogRequest: type: object additionalProperties: false required: - machineName - action - errorType - logLevel - message properties: machineName: type: string minLength: 1 action: type: string minLength: 1 errorType: type: string minLength: 1 logLevel: $ref: '#/components/schemas/LogLevel' errorCode: type: string nullable: true message: type: string minLength: 1 additionalData: type: object nullable: true additionalProperties: type: string LogLevel: type: integer description: 'Defines the available channel types invoking communication with the server. 0 = Verbose 1 = Information 2 = Warning 3 = Error 4 = Critical' x-enumNames: - Verbose - Information - Warning - Error - Critical enum: - 0 - 1 - 2 - 3 - 4 IJsonResponseOfListOfPassenger: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/Passenger' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' Passenger: type: object additionalProperties: false properties: customerNumber: type: string nullable: true passengerProgram: nullable: true $ref: '#/components/schemas/PassengerProgram' segments: type: array nullable: true items: $ref: '#/components/schemas/PassengerSegment' passengerAlternateKey: type: string nullable: true name: nullable: true $ref: '#/components/schemas/Name' passengerNumber: type: integer description: The Passenger's number based on their order in the booking. recordLocator: type: string nullable: true PassengerProgram: type: object additionalProperties: false properties: programCode: type: string nullable: true programLevelCode: type: string nullable: true programNumber: type: string nullable: true PassengerSegment: type: object additionalProperties: false properties: segmentKey: type: string nullable: true carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time status: $ref: '#/components/schemas/SegmentStatus' segmentType: $ref: '#/components/schemas/SegmentType' legs: type: array nullable: true items: $ref: '#/components/schemas/PassengerLeg' PassengerLeg: type: object additionalProperties: false properties: carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time liftStatus: $ref: '#/components/schemas/LiftStatus' boardingSequence: type: integer LiftStatus: type: integer description: '0 = Default 1 = CheckedIn 2 = Boarded 3 = NoShow' x-enumNames: - Default - CheckedIn - Boarded - NoShow enum: - 0 - 1 - 2 - 3 IJsonResponseOfListOfPrinter: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/Printer' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' Printer: type: object additionalProperties: false properties: printerKey: type: string nullable: true name: type: string nullable: true properties: type: array nullable: true items: $ref: '#/components/schemas/DeviceProperty' PrinterCommandsRequest: type: object additionalProperties: false required: - printer properties: printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true PrinterRequest: type: object additionalProperties: false required: - printerKey properties: printerKey: type: string minLength: 1 properties: type: array nullable: true items: $ref: '#/components/schemas/DeviceProperty' usages: type: array nullable: true items: type: string BoardingPassPrintStreamsRequest: type: object additionalProperties: false required: - printer - recordLocator - segmentKeys - passengerKeys properties: printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true recordLocator: type: string minLength: 1 segmentKeys: type: array items: type: string passengerKeys: type: array items: type: string IJsonResponseOfListOfBagTagPrintStreams: type: object additionalProperties: false properties: data: type: array nullable: true items: $ref: '#/components/schemas/BagTagPrintStreams' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' BagTagPrintStreams: type: object additionalProperties: false properties: baggageKey: type: string nullable: true printStreams: type: array nullable: true items: type: string BagTagPrintStreamsRequest: type: object additionalProperties: false required: - printer - recordLocator - baggageKeys properties: printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true recordLocator: type: string minLength: 1 baggageKeys: type: array items: type: string PaymentReceiptPrintStreamsRequest: type: object additionalProperties: false required: - recordLocator - stationCode - printer - paymentKey properties: recordLocator: type: string minLength: 1 stationCode: type: string description: 'The station code specifying which time zone will be used when formatting the receipt.' maxLength: 3 minLength: 3 printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true paymentKey: type: string minLength: 1 PassengerReceiptPrintStreamsRequest: type: object additionalProperties: false required: - recordLocator - stationCode - printer - passengerKeys properties: recordLocator: type: string minLength: 1 stationCode: type: string description: 'The station code specifying which time zone will be used when formatting the receipt.' maxLength: 3 minLength: 3 printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true passengerKeys: type: array items: type: string useKioskFormat: type: boolean description: 'If true, the print streams will be formatted for receipt type of Kiosk. If false or null, the print streams will be formatted for receipt type of PrintSelected.' BookingReceiptPrintStreamsRequest: type: object additionalProperties: false required: - recordLocator - stationCode - printer properties: recordLocator: type: string minLength: 1 stationCode: type: string description: 'The station code specifying which time zone will be used when formatting the receipt.' maxLength: 3 minLength: 3 printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true useSummaryFormat: type: boolean description: 'If true, the print streams will be formatted for receipt type of Summary. If false or null, the print streams will be formatted for receipt type of PrintAll.' IJsonResponseOfPrinterCommandsResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/PrinterCommandsResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' PrinterCommandsResponse: type: object additionalProperties: false properties: clientId: type: string nullable: true deviceName: type: string nullable: true responses: type: array nullable: true items: $ref: '#/components/schemas/PrinterCommandResponse' PrinterCommandResponse: type: object additionalProperties: false properties: documentId: type: string nullable: true isSuccessful: type: boolean errorCode: type: string description: Error Code that informs about any failures. nullable: true errorMessage: type: string description: 'Error Message that informs about any failures. Only set when IsSuccessful is false.' nullable: true result: type: string description: The actual result of the command. nullable: true responseData: type: array description: Any additinal data. nullable: true items: $ref: '#/components/schemas/ResponseData' ResponseData: type: object additionalProperties: false properties: key: type: string description: The key or name for this data. nullable: true value: type: string description: The value for this data. nullable: true PrinterInitializationRequest: type: object additionalProperties: false required: - printer - deviceManagerKey - clientName - clientId properties: printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true deviceManagerKey: type: string minLength: 1 clientName: type: string minLength: 1 clientId: type: string minLength: 1 BoardingPassPrintRequest: type: object additionalProperties: false required: - recordLocator - segmentKeys - passengerKeys - printer - deviceManagerKey - documentName - documentId - clientName - clientId properties: recordLocator: type: string minLength: 1 segmentKeys: type: array items: type: string passengerKeys: type: array items: type: string printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true deviceManagerKey: type: string minLength: 1 documentName: type: string minLength: 1 documentId: type: string minLength: 1 clientName: type: string minLength: 1 clientId: type: string minLength: 1 BagTagPrintRequest: type: object additionalProperties: false required: - recordLocator - baggageKeys - printer - deviceManagerKey - documentName - documentId - clientName - clientId properties: recordLocator: type: string minLength: 1 baggageKeys: type: array items: type: string printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true deviceManagerKey: type: string minLength: 1 documentName: type: string minLength: 1 documentId: type: string minLength: 1 clientName: type: string minLength: 1 clientId: type: string minLength: 1 PaymentReceiptPrintRequest: type: object additionalProperties: false required: - paymentKey - recordLocator - stationCode - printer - deviceManagerKey - documentName - documentId - clientName - clientId properties: paymentKey: type: string minLength: 1 recordLocator: type: string minLength: 1 stationCode: type: string description: 'The station code specifying which time zone will be used when formatting the receipt.' maxLength: 3 minLength: 3 printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true deviceManagerKey: type: string minLength: 1 documentName: type: string minLength: 1 documentId: type: string minLength: 1 clientName: type: string minLength: 1 clientId: type: string minLength: 1 PassengerReceiptPrintRequest: type: object additionalProperties: false required: - passengerKeys - recordLocator - stationCode - printer - deviceManagerKey - documentName - documentId - clientName - clientId properties: passengerKeys: type: array items: type: string useKioskFormat: type: boolean description: 'If true, the print streams will be formatted for receipt type of Kiosk. If false or null, the print streams will be formatted for receipt type of PrintSelected.' recordLocator: type: string minLength: 1 stationCode: type: string description: 'The station code specifying which time zone will be used when formatting the receipt.' maxLength: 3 minLength: 3 printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true deviceManagerKey: type: string minLength: 1 documentName: type: string minLength: 1 documentId: type: string minLength: 1 clientName: type: string minLength: 1 clientId: type: string minLength: 1 BookingReceiptPrintRequest: type: object additionalProperties: false required: - recordLocator - stationCode - printer - deviceManagerKey - documentName - documentId - clientName - clientId properties: useSummaryFormat: type: boolean description: 'If true, the print streams will be formatted for receipt type of Summary. If false or null, the print streams will be formatted for receipt type of PrintAll.' recordLocator: type: string minLength: 1 stationCode: type: string description: 'The station code specifying which time zone will be used when formatting the receipt.' maxLength: 3 minLength: 3 printer: $ref: '#/components/schemas/PrinterRequest' locationCode: type: string description: 'The location code specifying which preload or formatter will be used to generate streams. If not specified, the default location code from the JWT will be used.' nullable: true deviceManagerKey: type: string minLength: 1 documentName: type: string minLength: 1 documentId: type: string minLength: 1 clientName: type: string minLength: 1 clientId: type: string minLength: 1 IJsonResponseOfPrintPreview: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/PrintPreview' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' PrintPreview: type: object additionalProperties: false properties: header: type: string description: The report header text. nullable: true footer: type: string description: The report footer text. nullable: true body: type: array description: The lines of text constituting the report body. nullable: true items: type: string StandardLegReportType: type: integer description: '0 = AircraftZoneReport 1 = AppsOverrideReport 2 = BaggageReport 3 = BoardingHistoryReport 4 = CabinServiceAreaDetailedReport 5 = CabinServiceAreaSummaryReport 6 = DuplicateTravelDocumentReport 7 = FlightHistoryReport 8 = ManifestWithConnectionInformationReport 9 = ManifestWithTripDetailReport 10 = MealFulfillmentDetailedReport 11 = MealFulfillmentSummaryReport 12 = SeatAssignmentReport 13 = SelecteesByFlightReport' x-enumNames: - AircraftZoneReport - AppsOverrideReport - BaggageReport - BoardingHistoryReport - CabinServiceAreaDetailedReport - CabinServiceAreaSummaryReport - DuplicateTravelDocumentReport - FlightHistoryReport - ManifestWithConnectionInformationReport - ManifestWithTripDetailReport - MealFulfillmentDetailedReport - MealFulfillmentSummaryReport - SeatAssignmentReport - SelecteesByFlightReport enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 StandardLegReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - reportType - printer properties: legKey: type: string minLength: 1 reportType: $ref: '#/components/schemas/StandardLegReportType' printer: $ref: '#/components/schemas/PrinterRequest' IJsonResponseOfFlightSummaryPartialReport: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/FlightSummaryPartialReport' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' FlightSummaryPartialReport: type: object additionalProperties: false properties: zoneCounts: type: array description: 'The rows of data for the zone counts table, ordered as they will be displayed in the printed report.' nullable: true items: $ref: '#/components/schemas/ZoneCounts' baggageCounts: type: array description: 'The rows of data for the baggage counts table, ordered as they will be displayed in the printed report.' nullable: true items: $ref: '#/components/schemas/BaggageCounts' ZoneCounts: type: object additionalProperties: false properties: zoneName: type: string description: The name of the zone. nullable: true zoneRange: type: string description: The range of the zone. nullable: true weightCategoryCounts: type: array description: 'The passenger weight categories and counts for the zone, including only the categories that will be displayed in the printed report.' nullable: true items: $ref: '#/components/schemas/WeightCategoryCount' WeightCategoryCount: type: object additionalProperties: false properties: weightCategory: description: The weight category of passenger being counted. $ref: '#/components/schemas/FlightSummaryPassengerWeightCategory' count: type: integer description: The number of passengers in the weight category. format: int32 FlightSummaryPassengerWeightCategory: type: integer description: '1 = Male 2 = Female 3 = Child 4 = Infant 5 = Adult 6 = Total' x-enumNames: - Male - Female - Child - Infant - Adult - Total enum: - 1 - 2 - 3 - 4 - 5 - 6 BaggageCounts: type: object additionalProperties: false properties: destination: type: string description: The destination of the baggage. nullable: true totalWeight: type: integer description: The total weight of the baggage for this destination. format: int32 checkedCount: type: integer description: The number of bags for this destination with a status of Checked. format: int32 addedCount: type: integer description: The number of bags for this destination with a status of Added. format: int32 addedPrintedCount: type: integer description: The number of bags for this destination with a status of AddedPrinted. format: int32 FlightSummaryReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - weightType - printer - manifestCounts properties: legKey: type: string minLength: 1 weightType: description: Pounds or Kilograms (DAPI's weight type Default = Kilograms) $ref: '#/components/schemas/WeightType' printer: $ref: '#/components/schemas/PrinterRequest' manifestCounts: type: array description: 'The rows of data for the manifest counts table, ordered as they will be displayed in the printed report.' items: $ref: '#/components/schemas/ManifestCounts' ManifestCounts: type: object additionalProperties: false required: - filterType - cabinCounts properties: filterType: description: The filter type used to generate passenger counts. $ref: '#/components/schemas/ManifestPassengerFilterType' cabinCounts: type: array description: The cabins of service and passenger counts for the filter. items: $ref: '#/components/schemas/CabinCounts' CabinCounts: type: object additionalProperties: false required: - cabinCode - count properties: cabinCode: type: string description: The cabin of service. maxLength: 1 minLength: 0 count: type: integer description: The number of passengers in the cabin. format: int32 FlightInformationReportPrintStreamsRequest: type: object additionalProperties: false required: - carrierCode - departureDate - origin - printer properties: origin: type: string maxLength: 3 minLength: 3 carrierCode: type: string maxLength: 3 minLength: 2 departureDate: type: string format: date-time minLength: 1 destination: type: string maxLength: 3 minLength: 3 nullable: true flightNumber: type: string nullable: true opSuffix: type: string maxLength: 1 minLength: 0 nullable: true printer: $ref: '#/components/schemas/PrinterRequest' FlightCloseSortType: type: integer description: '0 = Name 1 = Seat 2 = Destination 3 = Sequence' x-enumNames: - Name - Seat - Destination - Sequence enum: - 0 - 1 - 2 - 3 FlightCloseReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - sortType - weightType - printer properties: legKey: type: string minLength: 1 sortType: $ref: '#/components/schemas/FlightCloseSortType' weightType: description: Pounds or Kilograms (DAPI's weight type Default = Kilograms) $ref: '#/components/schemas/WeightType' printer: $ref: '#/components/schemas/PrinterRequest' PrePostFlightManifestReportType: type: integer description: '0 = PostFlightManifest 1 = PreFlightManifest 2 = PreFlightManifestWithSeatMap' x-enumNames: - PostFlightManifest - PreFlightManifest - PreFlightManifestWithSeatMap enum: - 0 - 1 - 2 PrePostFlightManifestSortType: type: integer description: '0 = Seat 1 = Name' x-enumNames: - Seat - Name enum: - 0 - 1 PrePostFlightManifestReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - reportType - sortType - printer properties: legKey: type: string minLength: 1 reportType: $ref: '#/components/schemas/PrePostFlightManifestReportType' sortType: $ref: '#/components/schemas/PrePostFlightManifestSortType' printer: $ref: '#/components/schemas/PrinterRequest' CheckInReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - includeThruPassengers - displayNames - displaySeats - printer properties: legKey: type: string minLength: 1 includeThruPassengers: type: boolean displayNames: type: boolean displaySeats: type: boolean printer: $ref: '#/components/schemas/PrinterRequest' FlightManifestReportType: type: integer description: '0 = FlightManifest 1 = FlightManifestWithApisDetails 2 = PassengerDocument' x-enumNames: - FlightManifest - FlightManifestWithApisDetails - PassengerDocument enum: - 0 - 1 - 2 FlightManifestReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - reportType - printer properties: legKey: type: string minLength: 1 reportType: $ref: '#/components/schemas/FlightManifestReportType' printer: $ref: '#/components/schemas/PrinterRequest' DownlinePassengerAndCountReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - includeIatciFlights - showPassengerNames - printer properties: legKey: type: string minLength: 1 includeIatciFlights: type: boolean showPassengerNames: type: boolean printer: $ref: '#/components/schemas/PrinterRequest' BagWeightByLegReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - weightType - printer properties: legKey: type: string minLength: 1 weightType: description: Pounds or Kilograms (DAPI's weight type Default = Kilograms) $ref: '#/components/schemas/WeightType' printer: $ref: '#/components/schemas/PrinterRequest' DepartureManifestReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - passengerAlternateKeys - filterType - sortType - includeFullPassengerDetails - baggageTypesToIncludeInCount - recordLocatorFilterIsActive - printer properties: legKey: type: string minLength: 1 passengerAlternateKeys: type: array items: type: string filterType: $ref: '#/components/schemas/ManifestPassengerFilterType' sortType: $ref: '#/components/schemas/ManifestPassengerSortType' manifestPassengerSearchCriteria: nullable: true $ref: '#/components/schemas/ManifestPassengerSearchCriteria' includeFullPassengerDetails: type: boolean baggageTypesToIncludeInCount: type: array items: type: string recordLocatorFilterIsActive: type: boolean printer: $ref: '#/components/schemas/PrinterRequest' 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 ManifestPassengerSearchCriteria: type: object additionalProperties: false properties: bagTagNumber: type: string nullable: true boardingZone: type: string nullable: true finalDestination: type: string maxLength: 3 minLength: 3 nullable: true firstName: type: string nullable: true lastName: type: string nullable: true recordLocator: type: string nullable: true seatNumber: type: string nullable: true sequenceNumber: type: string nullable: true ssrCode: type: string nullable: true CheckedBaggagePrimarySortType: type: integer description: '0 = FlightNumber 1 = CityPair 2 = Sequence' x-enumNames: - FlightNumber - CityPair - Sequence enum: - 0 - 1 - 2 CheckedBaggageSecondarySortType: type: integer description: '0 = Name 1 = BagTag' x-enumNames: - Name - BagTag enum: - 0 - 1 CheckedBaggageReportPrintStreamsRequest: type: object additionalProperties: false required: - startDate - endDate - primarySortType - secondarySortType - weightType - includeUnflownPassengers - showSummaryOnly - carrierCode - printer properties: startDate: type: string format: date-time minLength: 1 endDate: type: string format: date-time minLength: 1 primarySortType: $ref: '#/components/schemas/CheckedBaggagePrimarySortType' secondarySortType: $ref: '#/components/schemas/CheckedBaggageSecondarySortType' weightType: description: Pounds or Kilograms (DAPI's weight type Default = Kilograms) $ref: '#/components/schemas/WeightType' includeUnflownPassengers: type: boolean showSummaryOnly: type: boolean carrierCode: type: string maxLength: 3 minLength: 2 flightNumber: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true agentName: type: string description: The username of the agent account that checked the baggage. nullable: true agentDomain: type: string description: 'The domain of the agent account that checked the baggage. If agentName is empty, this value is ignored.' nullable: true printer: $ref: '#/components/schemas/PrinterRequest' PassengerVerificationReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - includeUnverifiedPassenger - includePassengerAddress - printer properties: legKey: type: string minLength: 1 includeUnverifiedPassenger: type: boolean includePassengerAddress: type: boolean printer: $ref: '#/components/schemas/PrinterRequest' InboundPassengerAndCountReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - includeIatciFlights - showPassengerNames - printer properties: legKey: type: string minLength: 1 includeIatciFlights: type: boolean showPassengerNames: type: boolean printer: $ref: '#/components/schemas/PrinterRequest' AvailabilityReportPrintStreamsRequest: type: object additionalProperties: false required: - departureDate - carrierCode - origin - printer properties: departureDate: type: string format: date-time minLength: 1 carrierCode: type: string maxLength: 3 minLength: 2 origin: type: string maxLength: 3 minLength: 3 destination: type: string nullable: true printer: $ref: '#/components/schemas/PrinterRequest' FlightLoadReportPrintStreamsRequest: type: object additionalProperties: false required: - departureDate - origin - carrierCode - printer properties: departureDate: type: string format: date-time minLength: 1 origin: type: string maxLength: 3 minLength: 3 carrierCode: type: string maxLength: 2 minLength: 2 printer: $ref: '#/components/schemas/PrinterRequest' PaymentReceiptReportType: type: integer description: '0 = Summary 1 = Detailed' x-enumNames: - Summary - Detailed enum: - 0 - 1 PaymentReceiptReportDisplayCurrencySource: type: integer description: '0 = Payment 1 = Booking' x-enumNames: - Payment - Booking enum: - 0 - 1 PaymentReceiptReportPrintStreamsRequest: type: object additionalProperties: false required: - paymentDate - reportType - locationCode - displayCurrencySource - timeZoneCode - printer properties: paymentDate: type: string description: Search criteria specifying the date of the payment. format: date-time minLength: 1 reportType: description: The type of payment receipt report to be returned. $ref: '#/components/schemas/PaymentReceiptReportType' paymentMethodCode: type: string description: Search criteria specifying which payment method was used. nullable: true locationCode: type: string description: Search criteria specifying the location where the payment was accepted. minLength: 1 departmentCode: type: string description: Search criteria specifying the department code of the agent that accepted the payment. nullable: true agentName: type: string description: Search criteria specifying the name of the agent that accepted the payment. nullable: true currencyCode: type: string description: Search criteria specifying the currency that was used to make the payment. nullable: true baseCurrencyCode: type: string description: Search criteria specifying the base currency associated with the payment. nullable: true displayCurrencySource: description: Specifies whether to display the currency used in the booking or in the specific payment. $ref: '#/components/schemas/PaymentReceiptReportDisplayCurrencySource' timeZoneCode: type: string description: Specifies the time zone used in performing the search and displaying the report. minLength: 1 printer: $ref: '#/components/schemas/PrinterRequest' EnplanementDeplanementReportType: type: integer description: '0 = Enplanement 1 = Deplanement' x-enumNames: - Enplanement - Deplanement enum: - 0 - 1 EnplanementDeplanementReportSegmentStatus: type: integer description: '0 = Flown 1 = Open' x-enumNames: - Flown - Open enum: - 0 - 1 EnplanementDeplanementReportPrintStreamsRequest: type: object additionalProperties: false required: - startDate - endDate - showSummaryOnly - reportType - segmentStatus - includeConnections - carrierCode - printer properties: startDate: type: string format: date-time minLength: 1 endDate: type: string format: date-time minLength: 1 showSummaryOnly: type: boolean reportType: $ref: '#/components/schemas/EnplanementDeplanementReportType' segmentStatus: $ref: '#/components/schemas/EnplanementDeplanementReportSegmentStatus' station: type: string nullable: true includeConnections: type: boolean fareClasses: type: string nullable: true carrierCode: type: string maxLength: 3 minLength: 2 startFlightNumber: type: string nullable: true endFlightNumber: type: string nullable: true printer: $ref: '#/components/schemas/PrinterRequest' InventoryLegOpFileReportType: type: integer description: '0 = Both 1 = Weather 2 = Flight' x-enumNames: - Both - Weather - Flight enum: - 0 - 1 - 2 InventoryLegOpFileReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - reportType - printer properties: legKey: type: string minLength: 1 reportType: description: Property for the Report Type of the report $ref: '#/components/schemas/InventoryLegOpFileReportType' printer: $ref: '#/components/schemas/PrinterRequest' TransferBagTagSortType: type: integer description: '0 = PassengerLastName 1 = BagTag' x-enumNames: - PassengerLastName - BagTag enum: - 0 - 1 TransferBagTagReportPrintStreamsRequest: type: object additionalProperties: false required: - legKey - includeOaAndManualTags - sortType - printer properties: legKey: type: string minLength: 1 includeOaAndManualTags: type: boolean sortType: $ref: '#/components/schemas/TransferBagTagSortType' printer: $ref: '#/components/schemas/PrinterRequest' SegmentsByTimeReportPrintStreamsRequest: type: object additionalProperties: false required: - bookingDate - carrierCode - printer properties: bookingDate: type: string format: date-time minLength: 1 channelType: $ref: '#/components/schemas/ChannelType' carrierCode: type: string maxLength: 3 minLength: 2 printer: $ref: '#/components/schemas/PrinterRequest' BagTagTrackingReportPrintStreamsRequest: type: object additionalProperties: false required: - bagTag - date - printer properties: bagTag: type: string maxLength: 32 minLength: 0 date: type: string format: date-time minLength: 1 printer: $ref: '#/components/schemas/PrinterRequest' IJsonResponseOfCombinedScanV3: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/CombinedScanV3' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' CombinedScanV3: type: object additionalProperties: false properties: bagTagScan: nullable: true $ref: '#/components/schemas/BagTagScanV2' boardingPassScan: nullable: true $ref: '#/components/schemas/BoardingPassScanV2' creditCardScan: nullable: true $ref: '#/components/schemas/CreditCardScanV3' deviceIdScan: type: string nullable: true documentScan: nullable: true $ref: '#/components/schemas/DocumentScanV2' itineraryScan: nullable: true $ref: '#/components/schemas/ItineraryScanV2' membershipCardScan: nullable: true $ref: '#/components/schemas/MembershipCardScanV3' recordLocatorScan: type: string nullable: true BagTagScanV2: type: object additionalProperties: false properties: bagTag: type: string nullable: true carrierCode: type: string nullable: true taggedToStation: type: string nullable: true isDesignatedAsManual: type: boolean BoardingPassScanV2: type: object additionalProperties: false properties: recordLocator: type: string nullable: true firstName: type: string nullable: true lastName: type: string nullable: true departureDayOfMonth: type: integer description: 'Some boarding pass barcode formats only provide a day-of-month. The first segment''s DepartureTime should be checked first, and if it is not set, then this should be used.' format: int32 mobileBarcode: type: string nullable: true segments: type: array nullable: true items: $ref: '#/components/schemas/BoardingPassSegmentV2' BoardingPassSegmentV2: type: object additionalProperties: false properties: carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time legs: type: array nullable: true items: $ref: '#/components/schemas/BoardingPassLegV2' BoardingPassLegV2: type: object additionalProperties: false properties: carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time boardingSequence: type: integer unitDesignator: type: string description: The assigned seat. nullable: true CreditCardScanV3: type: object additionalProperties: false properties: paymentMethodCode: type: string nullable: true accountHolder: type: string nullable: true accountNumber: type: string nullable: true expirationMonth: type: string nullable: true name: nullable: true $ref: '#/components/schemas/Name' DocumentScanV2: type: object additionalProperties: false properties: document: nullable: true $ref: '#/components/schemas/DocumentV2' name: nullable: true $ref: '#/components/schemas/Name' DocumentV2: type: object additionalProperties: false properties: documentTypeCode: type: string nullable: true group: description: 'Corresponds to what NewSkies calls the DocumentType (which is different from the DocumentTypeCode).' $ref: '#/components/schemas/DocumentGroup' issuingCountryCode: type: string nullable: true documentDetails: type: array nullable: true items: $ref: '#/components/schemas/DataField' DataField: type: object additionalProperties: false properties: data: type: string nullable: true field: type: string nullable: true ItineraryScanV2: type: object additionalProperties: false properties: flightNumber: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true MembershipCardScanV3: type: object additionalProperties: false properties: carrierCode: type: string nullable: true tierCode: type: string nullable: true accountNumber: type: string nullable: true expirationMonth: type: string nullable: true name: nullable: true $ref: '#/components/schemas/Name' IJsonResponseOfCombinedScanV2: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/CombinedScanV2' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' CombinedScanV2: type: object deprecated: true x-deprecatedMessage: Use V3 instead. additionalProperties: false properties: bagTagScan: nullable: true $ref: '#/components/schemas/BagTagScanV2' boardingPassScan: nullable: true $ref: '#/components/schemas/BoardingPassScanV2' creditCardScan: nullable: true $ref: '#/components/schemas/CreditCardScanV2' deviceIdScan: type: string nullable: true documentScan: nullable: true $ref: '#/components/schemas/DocumentScanV2' itineraryScan: nullable: true $ref: '#/components/schemas/ItineraryScanV2' membershipCardScan: nullable: true $ref: '#/components/schemas/MembershipCardScanV2' recordLocatorScan: type: string nullable: true CreditCardScanV2: type: object deprecated: true x-deprecatedMessage: Use V3 instead. additionalProperties: false properties: paymentMethodCode: type: string nullable: true accountHolder: type: string nullable: true accountNumber: type: string nullable: true expirationDate: type: string format: date-time name: nullable: true $ref: '#/components/schemas/Name' MembershipCardScanV2: type: object deprecated: true x-deprecatedMessage: Use V3 instead. additionalProperties: false properties: carrierCode: type: string nullable: true tierCode: type: string nullable: true accountNumber: type: string nullable: true expirationDate: type: string format: date-time name: nullable: true $ref: '#/components/schemas/Name' IJsonResponseOfDownlineSegmentsResponse: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/DownlineSegmentsResponse' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' DownlineSegmentsResponse: type: object additionalProperties: false properties: downlineSegments: type: array nullable: true items: $ref: '#/components/schemas/DownlineSearchSegment' DownlineSearchSegment: type: object additionalProperties: false properties: carrierCode: type: string nullable: true flightNumber: type: string nullable: true opSuffix: type: string nullable: true origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time arrivalTime: type: string format: date-time segmentStatus: $ref: '#/components/schemas/SegmentStatus' segmentType: $ref: '#/components/schemas/SegmentType' isHosted: type: boolean legs: type: array nullable: true items: $ref: '#/components/schemas/DownlineSearchLeg' segmentKey: type: string nullable: true canSelect: type: boolean isBaggageCheckinAllowed: type: boolean DownlineSearchLeg: type: object additionalProperties: false properties: isCheckedIn: type: boolean displayLegStatus: $ref: '#/components/schemas/LegStatus' isProcessedOffline: type: boolean status: $ref: '#/components/schemas/LegStatus' origin: type: string nullable: true destination: type: string nullable: true departureTime: type: string format: date-time legKey: type: string nullable: true GetDownlineSegmentsRequest: type: object additionalProperties: false required: - segmentKeys - passengerAlternateKeys properties: segmentKeys: type: array items: type: string passengerAlternateKeys: type: array items: type: string IJsonResponseOfCheckinSettingsV2: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/CheckinSettingsV2' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' CheckinSettingsV2: type: object additionalProperties: false properties: allowWaiveSeatFees: type: boolean changeFeeCommentRequirementLevel: $ref: '#/components/schemas/ChangeFeeCommentRequirementLevel' changeFeeReasonDetails: type: array nullable: true items: $ref: '#/components/schemas/ChangeFeeReasonDetails' checkinGeneralRequirementTypeDetails: type: array nullable: true items: $ref: '#/components/schemas/CheckinGeneralRequirementTypeDetails' checkinSecurityRequirementTypeDetails: type: array nullable: true items: $ref: '#/components/schemas/CheckinSecurityRequirementTypeDetails' defaultBaggageType: type: string nullable: true 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 nullable: true items: $ref: '#/components/schemas/PairedSsrConfirmation' validateDuplicateDocumentWithinManifest: type: boolean maxPassengerBaggage: type: integer premiumFares: type: array nullable: true items: type: string ChangeFeeCommentRequirementLevel: type: integer description: '0 = Restricted 1 = Optional 2 = Mandatory' x-enumNames: - Restricted - Optional - Mandatory enum: - 0 - 1 - 2 ChangeFeeReasonDetails: type: object additionalProperties: false properties: code: type: string nullable: true description: type: string nullable: true CheckinGeneralRequirementTypeDetails: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinGeneralRequirementType' step: $ref: '#/components/schemas/CheckinStep' CheckinSecurityRequirementTypeDetails: type: object additionalProperties: false properties: requirementType: $ref: '#/components/schemas/CheckinSecurityRequirementType' step: $ref: '#/components/schemas/CheckinStep' PairedSsrConfirmation: type: object additionalProperties: false properties: name: type: string nullable: true prohibitedSsr: type: string nullable: true promptText: type: string nullable: true results: type: string nullable: true reasonCodeList: type: array nullable: true items: type: string clearedSsr: type: string nullable: true IJsonResponseOfDepartureSettings: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/DepartureSettings' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' 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 description: Ordered list of manifest filters to display. nullable: true items: $ref: '#/components/schemas/ManifestFilterOptions' ssrsForManifestFilterWithSpecificSsr: type: array description: List of SSR codes used by the manifest filter WithSpecificSsr (AKA Passenger Information List or PIL). nullable: true items: type: string manifestSortOptions: type: array description: Ordered list of manifest sort types to display. nullable: true 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 description: List of seat properties that should trigger a warning after successful boarding. nullable: true 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 description: List of SSR codes that should trigger a warning after successful boarding. nullable: true items: type: string boardingScanRegularExpressions: type: array 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. \n\ Below 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----------------------------------------------------------------------------------------------------\n\ ScanTYpes:\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----------------------------------------------------------------------------------------------------\n\ ScanTYpes:\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----------------------------------------------------------------------------------------------------\n\ ScanTYpes:\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" nullable: true items: $ref: '#/components/schemas/BoardingScanRegularExpression' bookingReseatingQueueCodes: type: array description: List of booking reseating queue codes. nullable: true 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 nullable: true apisDefaultPhoneNumber: type: string nullable: true apisPreliminaryCarrierCodes: type: array nullable: true items: type: string ssrCodesToHideInManifestSummary: type: array nullable: true items: type: string allowForceFlightVerify: type: boolean RestrictionLevel: type: integer description: '0 = Restrict 1 = Warn 2 = Allow' x-enumNames: - Restrict - Warn - Allow enum: - 0 - 1 - 2 BoardingWithoutSeatRestrictionLevel: type: integer description: '0 = Restrict 1 = AllowManualOnly 2 = Allow' x-enumNames: - Restrict - AllowManualOnly - Allow enum: - 0 - 1 - 2 ManifestFilterOptions: type: object additionalProperties: false properties: type: $ref: '#/components/schemas/ManifestPassengerFilterType' displayName: type: string nullable: true showInManifestView: type: boolean showInSeatsManagement: type: boolean showInAtAGlance: type: boolean defaultSortType: $ref: '#/components/schemas/ManifestPassengerSortType' ManifestSortOptions: type: object additionalProperties: false properties: type: $ref: '#/components/schemas/ManifestPassengerSortType' displayName: type: string nullable: true showInManifestView: type: boolean showInSeatsManagement: type: boolean BoardingScanRegularExpression: type: object additionalProperties: false properties: scanType: $ref: '#/components/schemas/BoardingScanType' regularExpression: type: string nullable: true captureGroupNames: type: array nullable: true items: $ref: '#/components/schemas/BoardingScanRegularExpressionCaptureGroupName' 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 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 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' 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 IJsonResponseOfKioskSettings: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/KioskSettings' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' KioskSettings: type: object additionalProperties: false properties: bagTagPrinter: nullable: true $ref: '#/components/schemas/PrinterRequest' boardingPassPrinter: nullable: true $ref: '#/components/schemas/PrinterRequest' receiptPrinter: nullable: true $ref: '#/components/schemas/PrinterRequest' defaultStationCode: type: string nullable: true IJsonResponseOfReportsSettings: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/ReportsSettings' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' ReportsSettings: 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 PairedSsrCommentsRequest: type: object additionalProperties: false required: - segmentKeys - passengerKeys - clearedSsrCode - ssrWasAdded properties: recordLocator: type: string description: Optional; if no record locator is provided, comments will be generated using the booking in state. nullable: true segmentKeys: type: array items: type: string passengerKeys: type: array items: type: string clearedSsrCode: type: string description: SSR code of the cleared SSR minLength: 1 ssrWasAdded: type: boolean description: Whether the cleared SSR was added reasonCode: type: string description: Reason code for paired SSR nullable: true IJsonResponseOfDcsToken: type: object additionalProperties: false properties: data: nullable: true $ref: '#/components/schemas/DcsToken' errors: type: array nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array nullable: true items: $ref: '#/components/schemas/Message' DcsToken: type: object additionalProperties: false properties: userName: type: string nullable: true domain: type: string nullable: true clientCode: type: string nullable: true locationCode: type: string description: 'The location code used as a default for location-specific settings and behaviors when no location code is specified in an API request.' nullable: true agentId: type: string nullable: true defaultCultureCode: type: string nullable: true defaultCurrencyCode: type: string nullable: true type: $ref: '#/components/schemas/SessionPermissionType' roleCode: type: string nullable: true authenticationSystemType: type: string nullable: true SessionPermissionType: type: integer description: 'Defines the sessions permission type. 0 = Unknown 1 = Customer 2 = Anonymous 3 = Agent' x-enumNames: - Unknown - Customer - Anonymous - Agent enum: - 0 - 1 - 2 - 3 securitySchemes: JWT: type: http description: Paste your JWT token from the token endpoint. scheme: bearer bearerFormat: jwt security: - JWT: []