x-generator: NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0)) openapi: 3.0.0 info: title: NewSkies-Digital-Api version: 4.8.6.23 description: Navitaire Digital Api servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground paths: /api/nsk/v1/account/password/challenge: post: tags: - account summary: Sends a challenge code for agents' reset password flow. description: 'This is the first step in the reset password flow to generate a challenge code. The challenge code is sent to the user''s email and/or phone number based on the domain configuration. To configure this flow, see the Reset Password tab in the `Edit Domain` window in `Management Console`. Related Endpoints: - POST /api/nsk/v1/account/password/challenge/verify: The optional step to verify the challenge code. - PUT /api/nsk/v1/account/password/challenge/reset: The second step to verify the challenge code and reset the password. Unrelated Endpoints: - POST /api/auth/v1/token/multifactor: MFA relies on separate configuration and is for login flows vs reset password flows. If the domain is not configured for the new password flow, the following endpoints should be used. - POST /api/nsk/v3/account/password/change: Expired password change using the anonymous login - POST api/nsk/v1/account/password/reset: Forgot password change using the anonymous login. - POST api/nsk/v3/user/password/change: Password change for the current login user. - POST api/nsk/v1/users/{userKey}/password/change: Password change for a specific user. - POST api/nsk/v1/users/{userKey}/password/reset: Forgot password change for a specific user. GraphQL endpoint: accountPasswordChallenge' operationId: nsk_v1_account_password_challenge_post requestBody: x-name: request description: The account password challenge request. content: application/json: schema: $ref: '#/components/schemas/AccountPasswordChallengeRequest' examples: With both phone number and email: description: Example request with both phone number and email. value: domain: EXT username: agent phoneNumber: '+11111111111' email: agent@mail.com With a phone number only: description: Example request with a phone number only. value: domain: EXT username: agent phoneNumber: '+11111111111' email: null With an email only: description: Example request with an email only. value: domain: EXT username: agent phoneNumber: null email: agent@mail.com required: true x-position: 1 responses: '202': description: Accepted, a challenge code was generated. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: Challenge code generated: description: Example response when a challenge code was successfully generated. Please check the user's email and/or phone number for the challenge code. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Domain configuration does not allow agents to use the new reset password flow: description: Example when the domain configuration does not allow agents to use the new reset password flow. Check the UseNewResetPasswordFlow property in /resources/Domains. value: errors: - id: null code: nsk-server:UseOldResetPasswordFlow message: Current carrier settings for your domain EXT do not allow agents to reset their own password. type: Error details: errorNumber: '1667' sessionException: UseOldResetPasswordFlow rawMessage: Current carrier settings for your domain EXT do not allow agents to reset their own password. 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 Agent does not exist: description: Example when the agent does not exist. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: No agent found for requested agent name EXT/agent. 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 Agent exceeded maximum allowed attempts in the reset password flow: description: Example when the agent exceeded maximum allowed attempts in the reset password flow. value: errors: - id: null code: nsk-server:Credentials:RateLimited message: The agent (EXT/agent) has exceeded challenge code, and contact method match attempts in the password reset flow. type: Error details: errorNumber: '1622' sessionException: PasswordResetDisabled rawMessage: The agent (EXT/agent) has exceeded challenge code, and contact method match attempts in the password reset flow. 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 Agent attempts the reset password flow after exceeding the maximum allowed attempts: description: Example when the agent attempts the reset password flow after exceeding the maximum allowed attempts. value: errors: - id: null code: nsk-server:Credentials:RateLimited message: The agent (EXT/agent) attempted a password reset step while the password reset flow was disabled. type: Error details: errorNumber: '1650' sessionException: AttemptWhilePasswordResetDisabled rawMessage: The agent (EXT/agent) attempted a password reset step while the password reset flow was disabled. 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 Phone number or email is a required contact method but is null, empty, or invalid in the request: description: Example when the phone number or email is a required contact method but is null, empty, or invalid in the request. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: The agent (EXT/agent) failed authentication. 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: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Authentication token is missing or invalid: description: Example when the authentication token is missing or invalid. value: null /api/nsk/v1/account/password/challenge/reset: put: tags: - account summary: Resets the password for agents using challenge code authentication. description: 'This is the second step in the reset password flow. To configure this flow, see the Reset Password tab in the `Edit Domain` window in `Management Console`. Related Endpoints: - POST /api/nsk/v1/account/password/challenge: The first step to generate the challenge code. - POST /api/nsk/v1/account/password/challenge/verify: The optional step to verify the challenge code. Unrelated Endpoints: - POST /api/auth/v1/token/multifactor: MFA relies on separate configuration and is for login flows vs reset password flows. If the domain is not configured for the new password flow, the following endpoints should be used. - POST /api/nsk/v3/account/password/change: Expired password change using the anonymous login - POST api/nsk/v1/account/password/reset: Forgot password change using the anonymous login. - POST api/nsk/v3/user/password/change: Password change for the current login user. - POST api/nsk/v1/users/{userKey}/password/change: Password change for a specific user. - POST api/nsk/v1/users/{userKey}/password/reset: Forgot password change for a specific user. GraphQL endpoint: accountPasswordChallengeReset' operationId: nsk_v1_account_password_challenge_reset_put requestBody: x-name: request description: The account password challenge reset request. content: application/json: schema: $ref: '#/components/schemas/AccountPasswordChallengeResetRequest' examples: Valid request: description: Example request for resetting a password. value: domain: EXT username: agent challengeCode: '123456' newPassword: NewPass required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Password is reset: description: Example response for a successful password reset. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Domain configuration does not allow agents to use the new reset password flow: description: Example when the domain configuration does not allow agents to use the new reset password flow. Check the UseNewResetPasswordFlow property in /resources/Domains. value: errors: - id: null code: nsk-server:UseOldResetPasswordFlow message: Current carrier settings for your domain EXT do not allow agents to reset their own password. type: Error details: errorNumber: '1667' sessionException: UseOldResetPasswordFlow rawMessage: Current carrier settings for your domain EXT do not allow agents to reset their own password. 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 Agent does not exist: description: Example when the agent does not exist. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: No agent found for requested agent name EXT/agent. 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 Agent exceeded maximum allowed attempts in the reset password flow: description: Example when the agent exceeded maximum allowed attempts in the reset password flow. value: errors: - id: null code: nsk-server:Credentials:RateLimited message: The agent (EXT/agent) has exceeded challenge code, and contact method match attempts in the password reset flow. type: Error details: errorNumber: '1622' sessionException: PasswordResetDisabled rawMessage: The agent (EXT/agent) has exceeded challenge code, and contact method match attempts in the password reset flow. 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 Agent attempts the reset password flow after exceeding the maximum allowed attempts: description: Example when the agent attempts the reset password flow after exceeding the maximum allowed attempts. value: errors: - id: null code: nsk-server:Credentials:RateLimited message: The agent (EXT/agent) attempted a password reset step while the password reset flow was disabled. type: Error details: errorNumber: '1650' sessionException: AttemptWhilePasswordResetDisabled rawMessage: The agent (EXT/agent) attempted a password reset step while the password reset flow was disabled. 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 Challenge code is invalid or expired: description: Example when the challenge code is invalid or expired. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: Challenge code entered does not match for agent or is expired (EXT/agent). 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: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Authentication token is missing or invalid: description: Example when the authentication token is missing or invalid. value: null /api/nsk/v1/account/password/challenge/verify: post: tags: - account summary: Verifies the challenge code for agents' reset password flow. description: 'This is an optional step between creating a challenge code and resetting the password. To configure this flow, see the Reset Password tab in the `Edit Domain` window in `Management Console`. Related Endpoints: - POST /api/nsk/v1/account/password/challenge: The first step to generate the challenge code. - PUT /api/nsk/v1/account/password/challenge/reset: The second step to verify the challenge code and reset the password. Unrelated Endpoints: - POST /api/auth/v1/token/multifactor: MFA relies on separate configuration and is for login flows vs reset password flows. If the domain is not configured for the new password flow, the following endpoints should be used. - POST /api/nsk/v3/account/password/change: Expired password change using the anonymous login - POST api/nsk/v1/account/password/reset: Forgot password change using the anonymous login. - POST api/nsk/v3/user/password/change: Password change for the current login user. - POST api/nsk/v1/users/{userKey}/password/change: Password change for a specific user. - POST api/nsk/v1/users/{userKey}/password/reset: Forgot password change for a specific user. GraphQL endpoint: accountPasswordChallengeVerify' operationId: nsk_v1_account_password_challenge_verify_post requestBody: x-name: request description: The account password challenge verify request. content: application/json: schema: $ref: '#/components/schemas/AccountPasswordChallengeVerifyRequest' examples: Valid request: description: Example request of verifying the challenge code. value: domain: EXT username: agent challengeCode: '123456' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Challenge code is verified: description: Example when the challenge code is verified. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Domain configuration does not allow agents to use the new reset password flow: description: Example when the domain configuration does not allow agents to use the new reset password flow. Check the UseNewResetPasswordFlow property in /resources/Domains. value: errors: - id: null code: nsk-server:UseOldResetPasswordFlow message: Current carrier settings for your domain EXT do not allow agents to reset their own password. type: Error details: errorNumber: '1667' sessionException: UseOldResetPasswordFlow rawMessage: Current carrier settings for your domain EXT do not allow agents to reset their own password. 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 Agent does not exist: description: Example when the agent does not exist. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: No agent found for requested agent name EXT/agent. 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 Agent exceeded maximum allowed attempts in the reset password flow: description: Example when the agent exceeded maximum allowed attempts in the reset password flow. value: errors: - id: null code: nsk-server:Credentials:RateLimited message: The agent (EXT/agent) has exceeded challenge code, and contact method match attempts in the password reset flow. type: Error details: errorNumber: '1622' sessionException: PasswordResetDisabled rawMessage: The agent (EXT/agent) has exceeded challenge code, and contact method match attempts in the password reset flow. 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 Agent attempts the reset password flow after exceeding the maximum allowed attempts: description: Example when the agent attempts the reset password flow after exceeding the maximum allowed attempts. value: errors: - id: null code: nsk-server:Credentials:RateLimited message: The agent (EXT/agent) attempted a password reset step while the password reset flow was disabled. type: Error details: errorNumber: '1650' sessionException: AttemptWhilePasswordResetDisabled rawMessage: The agent (EXT/agent) attempted a password reset step while the password reset flow was disabled. 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 Challenge code is invalid or expired: description: Example when the challenge code is invalid or expired. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: Challenge code entered does not match for agent or is expired (EXT/agent). 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: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Authentication token is missing or invalid: description: Example when the authentication token is missing or invalid. value: null /api/nsk/v3/account/password/change: post: tags: - account summary: Changes the accounts password. description: 'This endpoint is recommended for a user who has an expired password. This endpoint is restricted to the anonymous user only and remains as the anonymous user even if the change password operation completed. For changing the password of a logged-in user, please use /api/nsk/v3/user/password/change. This follows domain level restrictions and could result in a failed change if there is a minimum time requirement between password changes, invalid password length, or invalid character. GraphQL endpoint: accountPasswordChangev3' operationId: nsk_v3_account_password_change_post requestBody: x-name: request description: The change password request. content: application/json: schema: $ref: '#/components/schemas/AccountChangePasswordRequestv2' examples: Request with username: description: Validates the provided credentials then updates that user's password with the provided new one. value: credentials: username: agentUsername123 alternateIdentifier: null password: OldPassword123! domain: WWW location: WWW loginRole: WWWA newPassword: NewPassword123! Request with alternate ID: description: Functionally the same, but uses alternate IDs such as customer number. value: credentials: username: null alternateIdentifier: '12345678' password: OldPassword123! domain: WWW location: WWW loginRole: WWWA newPassword: NewPassword123! required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Error response for incorrect domain, username, or password.: description: Only returns raw message in debug mode. value: errors: - id: null code: nsk:PasswordChange:Failed message: null type: Error details: null rawMessage: 'nsk-server:AgentAuthentication: The agent (WWW/ABC123) was not authenticated' 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 Error response for a locked account.: description: Only returns raw message in debug mode. value: errors: - id: null code: nsk:PasswordChange:Failed message: null type: Error details: null rawMessage: 'nsk-server:AgentLocked: The agent (WWW/ABC123) is locked.' 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 Error response for minimum password time.: description: Only returns raw message in debug mode. Minimum time is determined by domain configuration. value: errors: - id: null code: nsk:PasswordChange:Failed message: null type: Error details: null rawMessage: 'nsk-server:PasswordMinimumTime: The agent (WWW/ABC123) cannot change their password before the Minimum Time is up.' 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 Error response for password policy violation.: description: Only returns raw message in debug mode. Password policy is configurable and determined by the domain. value: errors: - id: null code: nsk:PasswordChange:Failed message: null type: Error details: null rawMessage: 'nsk-server:PasswordPolicy: X, Y, Z' 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 Error response when the new password is already used as password before.: description: Only returns raw message in debug mode. Unique password count is determined by domain configuration. value: errors: - id: null code: nsk-server:PasswordHistory message: nsk-server:PasswordHistory type: Information details: null rawMessage: The agent (WWW/tst01) cannot reuse this password. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/account/password/reset: post: tags: - account summary: Invokes the forgot password reset for a specific account. description: 'GraphQL endpoint: accountPasswordForgot' operationId: nsk_v1_account_password_reset_post requestBody: x-name: request description: The forgot password request. content: application/json: schema: $ref: '#/components/schemas/AccountForgotPasswordRequest' required: true x-position: 1 responses: '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/apisMessage: post: tags: - apisMessage summary: 'Takes the ApisMessage Request and sends it to core to queue a new message. Returns 201 in the response if message successfully queued and a message with Verified and Infant Counts, and 400 if errors occur (And failure text (if any) will be returned).' description: 'GraphQL endpoint: apisMessageQueue' operationId: nsk_v1_apisMessage_post requestBody: x-name: request description: The generate APIS Message Request. content: application/json: schema: $ref: '#/components/schemas/ApisQueueRequest' required: true x-position: 1 responses: '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/apo: get: tags: - apo summary: Gets the current saved ancillary pricing options data. description: 'GraphQL endpoint: apo' operationId: nsk_v1_apo_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAncillaryPricingOptionsContext' examples: With a sampling random number and input parameters: description: Example response with a sampling random number and input parameters. value: data: samplingRandomNumber: 0.9707756000434866 inputParameters: flightType: Through numberOfPassengers: '1' overrideSamplingRandomNumber: '0.2896014406763024' With a sampling random number: description: Example response with a sampling random number. value: data: samplingRandomNumber: 0.9707756000434866 inputParameters: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No sampling random number and input parameters: description: Example response when there are no sampling random number and input parameters. value: data: null post: tags: - apo summary: Adds new entries to the saved ancillary pricing options data. description: 'GraphQL endpoint: apoAddv2' operationId: nsk_v1_apo_post requestBody: x-name: inputParameters description: The input parameters to add. content: application/json: schema: type: object additionalProperties: type: string examples: Adding input parameters: description: Example request for adding input parameters. value: numberOfPassengers: '1' flightType: Through Overriding the sampling random number: description: Example request for overriding the sampling random number. value: overrideSamplingRandomNumber: '0.28960144067630239' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Input parameter/s are added successfully: description: Example response when the input parameter/s are added successfully. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: APO is not enabled: description: Example response when APO is not enabled. Please coordinate with your Navitaire account manager if this functionality needs to be enabled. value: errors: - id: null code: nsk:AncillaryPricingOptions:NotEnabled message: nsk:AncillaryPricingOptions:NotEnabled type: Error details: null rawMessage: The ancillary pricing options functionality is not enabled for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null put: tags: - apo summary: Adds new or updates existing ancillary pricing options data. description: Adds new or updates existing ancillary pricing options data. operationId: nsk_v1_apo_put requestBody: x-name: inputParameters description: The input parameters to add or update. content: application/json: schema: type: object additionalProperties: type: string examples: Updating input parameters: description: Example request for updating input parameters. value: numberOfPassengers: '2' flightType: Direct Overriding the sampling random number: description: Example request for overriding the sampling random number. value: overrideSamplingRandomNumber: '0.3360151380002569' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Input parameter/s are updated successfully: description: Example response when the input parameter/s are updated successfully. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: APO is not enabled: description: Example response when APO is not enabled. Please coordinate with your Navitaire account manager if this functionality needs to be enabled. value: errors: - id: null code: nsk:AncillaryPricingOptions:NotEnabled message: nsk:AncillaryPricingOptions:NotEnabled type: Error details: null rawMessage: The ancillary pricing options functionality is not enabled for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null The request body is null or empty: description: Example error when the request body is null or empty. value: errors: - id: null code: nsk:AncillaryPricingOptions:EmptyInputParameters message: nsk:AncillaryPricingOptions:EmptyInputParameters type: Validation details: null rawMessage: The requested update for input parameters is empty. Update could not be completed. 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 delete: tags: - apo summary: Deletes all of the saved ancillary pricing options data. description: 'GraphQL endpoint: apoDeleteAll' operationId: nsk_v1_apo_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Input parameter/s are deleted successfully: description: Example response when the input parameter/s are deleted successfully. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: APO is not enabled: description: Example response when APO is not enabled. Please coordinate with your Navitaire account manager if this functionality needs to be enabled. value: errors: - id: null code: nsk:AncillaryPricingOptions:NotEnabled message: nsk:AncillaryPricingOptions:NotEnabled type: Error details: null rawMessage: The ancillary pricing options functionality is not enabled for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/apo/{inputParameterKey}: put: tags: - apo summary: Updates an individual saved ancillary pricing option's data. description: 'This will replace the current saved ancillary pricing option''s value with the given input parameter value, based on the input parameter key. GraphQL endpoint: apoSet' operationId: nsk_v1_apo_inputParameterKey_put parameters: - name: inputParameterKey in: path required: true description: The input parameter key to update. schema: type: string x-position: 1 - name: inputParameterValue in: query description: The input parameter value to update. schema: type: string nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Input parameter/s are updated successfully: description: Example response when the input parameter/s are updated successfully. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: APO is not enabled: description: Example response when APO is not enabled. Please coordinate with your Navitaire account manager if this functionality needs to be enabled. value: errors: - id: null code: nsk:AncillaryPricingOptions:NotEnabled message: nsk:AncillaryPricingOptions:NotEnabled type: Error details: null rawMessage: The ancillary pricing options functionality is not enabled for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null No saved input parameters: description: Example error when there are no input parameters. value: errors: - id: null code: nsk:AncillaryPricingOptions:DoesNotExist message: nsk:AncillaryPricingOptions:DoesNotExist type: Validation details: null rawMessage: There are no saved ancillary pricing options for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null The specified input parameter does not exist: description: Example error when the specified input parameter does not exist. value: errors: - id: null code: nsk:AncillaryPricingOptions:InputParameterDoesNotExist message: nsk:AncillaryPricingOptions:InputParameterDoesNotExist type: Validation details: null rawMessage: An input parameter with the key NumberOfPassengers does not exist for the saved ancillary pricing options context. 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 delete: tags: - apo summary: Deletes a single saved ancillary pricing option's data. description: 'GraphQL endpoint: apoDelete' operationId: nsk_v1_apo_inputParameterKey_delete parameters: - name: inputParameterKey in: path required: true description: The input parameter key to delete. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Input parameter/s are deleted successfully: description: Example response when the input parameter/s are deleted successfully. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: APO is not enabled: description: Example response when APO is not enabled. Please coordinate with your Navitaire account manager if this functionality needs to be enabled. value: errors: - id: null code: nsk:AncillaryPricingOptions:NotEnabled message: nsk:AncillaryPricingOptions:NotEnabled type: Error details: null rawMessage: The ancillary pricing options functionality is not enabled for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null No saved input parameters: description: Example error when there are no input parameters. value: errors: - id: null code: nsk:AncillaryPricingOptions:DoesNotExist message: nsk:AncillaryPricingOptions:DoesNotExist type: Validation details: null rawMessage: There are no saved ancillary pricing options for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null The specified input parameter does not exist: description: Example error when the specified input parameter does not exist. value: errors: - id: null code: nsk:AncillaryPricingOptions:InputParameterDoesNotExist message: nsk:AncillaryPricingOptions:InputParameterDoesNotExist type: Validation details: null rawMessage: An input parameter with the key NumberOfPassengers does not exist for the saved ancillary pricing options context. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v3/availability/lowfare: post: tags: - availability summary: 'Searches for low fare availability with the full low fare search request. This request allows for total control over the configuration. If a property is not set, the default settings (LowFareAvailabilitySettings) are used in its place. Note low fare will not always match availability requests for certain configurations including sorting by taxes and fees.' description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. When LowFareAvailabilityRequest.GetAllDetails is set to true, New Skies sets the passenger count in the request to zero. This means that passenger count restrictions on a fare are not considered and that any available fare is returned. GraphQL endpoint: availabilityLowFarev3' operationId: nsk_v3_availability_lowfare_post requestBody: x-name: request description: The low fare availability request. content: application/json: schema: $ref: '#/components/schemas/LowFareAvailabilityRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfLowFareAvailabilityv2' examples: 200 OK Response With Macs, One Way: description: Example response for a successful call for a one way flight, with macs included. value: data: trips: - lowFareAvailableByMarket: slC|BOS: - lowestFareAmount: fareAmount: 40.0 farePointAmount: 0.0 taxesAndFeesAmount: 0.0 lowFares: - passengers: adt: discountCode: null fareAmount: 40.0 type: ADT farePointAmount: 0.0 taxesAndFeesAmount: 0.0 bookingClasses: - E arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' legs: - arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' destination: BOS origin: SLC flightNumber: '5600' carrierCode: NV equipmentType: '380' operatingCarrier: null availableCount: 24 productClass: null referenceFareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flg- soldOut: false destination: BOS origin: SLC departureDate: '2024-02-01T00:00:00' noFlights: false slC|MHT: - lowestFareAmount: fareAmount: 50.0 farePointAmount: 0.0 taxesAndFeesAmount: 0.0 lowFares: - passengers: adt: discountCode: null fareAmount: 50.0 type: ADT farePointAmount: 0.0 taxesAndFeesAmount: 0.0 bookingClasses: - Y arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' legs: - arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' destination: MHT origin: SLC flightNumber: '5200' carrierCode: NV equipmentType: '280' operatingCarrier: null availableCount: 24 productClass: null referenceFareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flt soldOut: false destination: MHT origin: SLC departureDate: '2024-02-01T00:00:00' noFlights: false includeTaxesAndFees: false currencyCode: USD 200 OK Response, round trip: description: Example response for a successful call round trip value: data: trips: - lowFareAvailableByMarket: slC|BOS: - lowestFareAmount: fareAmount: 40.0 farePointAmount: 0.0 taxesAndFeesAmount: 0.0 lowFares: - passengers: adt: discountCode: null fareAmount: 40.0 type: ADT farePointAmount: 0.0 taxesAndFeesAmount: 0.0 bookingClasses: - E arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' legs: - arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' destination: BOS origin: SLC flightNumber: '5600' carrierCode: NV equipmentType: '380' operatingCarrier: null availableCount: 24 productClass: null referenceFareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flg- soldOut: false destination: BOS origin: SLC departureDate: '2024-02-01T00:00:00' noFlights: false - lowFareAvailableByMarket: boS|SLC: - lowestFareAmount: fareAmount: 80.0 farePointAmount: 0.0 taxesAndFeesAmount: 0.0 lowFares: - passengers: adt: discountCode: null fareAmount: 80.0 type: ADT farePointAmount: 0.0 taxesAndFeesAmount: 0.0 bookingClasses: - E arrivalTime: '2024-02-06T00:00:00' departureTime: '2024-02-06T00:00:00' legs: - arrivalTime: '2024-02-06T00:00:00' departureTime: '2024-02-06T00:00:00' destination: SLC origin: BOS flightNumber: '6500' carrierCode: NV equipmentType: '830' operatingCarrier: null availableCount: 50 productClass: null referenceFareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfj soldOut: false destination: SLC origin: BOS departureDate: '2024-02-06T00:00:00' noFlights: false includeTaxesAndFees: false currencyCode: USD '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/availability/lowfare/estimate: get: tags: - availability summary: Retrieves the low fare availability estimate using a range of dates. description: 'This endpoint, unless otherwise specified, will request the pricing and availability for a single adult passenger. However, the number of passengers can be set on the request. It is important to note that the pricing on this endpoint is estimated. It will not match availability due to round trip vs one way discounts, taxes and fees variations, multi passenger discounts, recently sold out fares, etc. It''s intended to be an estimate only. Due to these restrictions this endpoint is extremely performant and can be configured to be cached, with a high cache hit rate. GraphQL endpoint: availabilityLowFareEstimate' operationId: nsk_v1_availability_lowfare_estimate_get parameters: - name: StartDate in: query description: "The start date to retrieve from the low fare cache.\n \ \ " schema: type: string format: date-time nullable: true x-position: 1 - name: EndDate in: query description: "The end date for the low fare cache request.\n " schema: type: string format: date-time nullable: true x-position: 2 - name: Origin in: query description: "The origin station code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 3 - name: Destination in: query description: "The destination station code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 4 - name: CurrencyCode in: query description: "The currency code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 5 - name: IncludeTaxesAndFees in: query description: "A flag to indicate if taxes and fees should be included.\n \ \ " schema: type: boolean nullable: true x-position: 6 - name: NumberOfPassengers in: query description: "The number of passengers\n " schema: type: integer nullable: true x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfLowFareEstimateResults' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/availability/lowfare/simple: post: tags: - availability summary: 'Searches for low fare availability with the simple search request. The simple search request covers the common search criteria and lets default settings (LowFareAvailabilitySettings) configure the rest. Note low fare will not always match availability requests for certain configurations included sorting by taxes and fees.' description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. GraphQL endpoint: availabilityLowFareSimplev3' operationId: nsk_v3_availability_lowfare_simple_post requestBody: x-name: request description: The low fare availability search simple request. content: application/json: schema: $ref: '#/components/schemas/LowFareAvailabilitySearchSimpleRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfLowFareAvailabilityv2' examples: 200 OK Response With Macs, One Way: description: Example response for a successful call for a one way flight, with macs included. value: data: trips: - lowFareAvailableByMarket: slC|BOS: - lowestFareAmount: fareAmount: 40.0 farePointAmount: 0.0 taxesAndFeesAmount: 0.0 lowFares: - passengers: adt: discountCode: null fareAmount: 40.0 type: ADT farePointAmount: 0.0 taxesAndFeesAmount: 0.0 bookingClasses: - E arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' legs: - arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' destination: BOS origin: SLC flightNumber: '5600' carrierCode: NV equipmentType: '380' operatingCarrier: null availableCount: 24 productClass: null referenceFareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flg- soldOut: false destination: BOS origin: SLC departureDate: '2024-02-01T00:00:00' noFlights: false slC|MHT: - lowestFareAmount: fareAmount: 50.0 farePointAmount: 0.0 taxesAndFeesAmount: 0.0 lowFares: - passengers: adt: discountCode: null fareAmount: 50.0 type: ADT farePointAmount: 0.0 taxesAndFeesAmount: 0.0 bookingClasses: - Y arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' legs: - arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' destination: MHT origin: SLC flightNumber: '5200' carrierCode: NV equipmentType: '280' operatingCarrier: null availableCount: 24 productClass: null referenceFareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flt soldOut: false destination: MHT origin: SLC departureDate: '2024-02-01T00:00:00' noFlights: false includeTaxesAndFees: false currencyCode: USD 200 OK Response, round trip: description: Example response for a successful call round trip value: data: trips: - lowFareAvailableByMarket: slC|BOS: - lowestFareAmount: fareAmount: 40.0 farePointAmount: 0.0 taxesAndFeesAmount: 0.0 lowFares: - passengers: adt: discountCode: null fareAmount: 40.0 type: ADT farePointAmount: 0.0 taxesAndFeesAmount: 0.0 bookingClasses: - E arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' legs: - arrivalTime: '2024-02-01T00:00:00' departureTime: '2024-02-01T00:00:00' destination: BOS origin: SLC flightNumber: '5600' carrierCode: NV equipmentType: '380' operatingCarrier: null availableCount: 24 productClass: null referenceFareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flg- soldOut: false destination: BOS origin: SLC departureDate: '2024-02-01T00:00:00' noFlights: false - lowFareAvailableByMarket: boS|SLC: - lowestFareAmount: fareAmount: 80.0 farePointAmount: 0.0 taxesAndFeesAmount: 0.0 lowFares: - passengers: adt: discountCode: null fareAmount: 80.0 type: ADT farePointAmount: 0.0 taxesAndFeesAmount: 0.0 bookingClasses: - E arrivalTime: '2024-02-06T00:00:00' departureTime: '2024-02-06T00:00:00' legs: - arrivalTime: '2024-02-06T00:00:00' departureTime: '2024-02-06T00:00:00' destination: SLC origin: BOS flightNumber: '6500' carrierCode: NV equipmentType: '830' operatingCarrier: null availableCount: 50 productClass: null referenceFareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfj soldOut: false destination: SLC origin: BOS departureDate: '2024-02-06T00:00:00' noFlights: false includeTaxesAndFees: false currencyCode: USD '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v4/availability/search: post: tags: - availability summary: 'Searches for availability with the full availability search request. This request allows for total control over the configuration. If a property is not set, default values will be set instead. These defaults are what we consider a general optimized request. If these optimizations are not preferred the requester will need to opted out the filters on the availability request.' description: 'Note: It is advised to optimize the availability request with passing in at least one or more (ProductClass, TravelClass, FareTypes or ClassesOfService) so the response can be optimized as possible. This is even more recommended for mobile applications due to the nature of limited network capabilities. The default values that will be set unless specified: - TaxesAndFees = TaxesAndFeesRollupMode.None - Criteria.SsrCollectionsMode = AvailabilitySsrCollectionsMode.None - Criteria.Filters.FareInclusionType = AvailabilityType.Default - Criteria.Filters.CompressionType = FareClassControl.LowestFareClass - Criteria.Filters.Loyalty = LoyaltyFilter.MonetaryOnly - Criteria.Filters.FlightType = FlightType.All - Criteria.Filters.ExclusionType = AvailabilityFilter.ExcludeUnavailable - Criteria.Filters.SortOptions = JourneySortKey.LowestFare,JourneySortKey.EarliestDeparture,JourneySortKey.ShortestTravelTime - Filters.ConnectionType = SoldAsConnectionType.None - Criteria.Filters.MaxConnectingFlights = 0 - Criteria.Stations.SearchDestinationMacs = false - Criteria.Stations.SearchOriginMacs = false - Criteria.Filters.BundleControlFilter = BundleControlFilter.Disabled - NumberOfFaresPerJourney = 1 Criteria.Filters.IncludeServiceBundleSetCodes is marked as obsolete, and the use of BundleControlFilter is preferred. To specifically return bundle set codes which IncludeServiceBundleSetCodes has originally provided when set to true, use an enumeration value of BundleControlFilter.ReturnBundleSets for BundleControlFilter instead. When searching for open jaw availability the results will contain only available markets if any are configured. The AvailabilityCriteriaFilter.FareInclusionType.NoPricing enumeration value, if set, will result in an availability response that does not include fares. The primary use case for this is in Move flows, but is being maintained on the main availability and rebook availability flows in case there are other use cases as well. GraphQL endpoint: availabilityv5' operationId: nsk_v4_availability_search_post requestBody: x-name: request description: The availability search request. content: application/json: schema: $ref: '#/components/schemas/AvailabilityRequestv3' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' examples: Requested Passenger Discount Overridden Message: description: Example OSI Message when getting availability with a promotion code, no requested passenger discount, and the promotion code has a passenger discount associated with it. *NOTE*:This example *only* displays the message, however, the availability data will be populated in addition the given message. value: messages: - rawValue: 'A passenger discount code was found that is associated with the requested promotion code. The passenger discount code on the request has been override with the following associated discount code: SNR.' code: PassengerDiscountCodeOverridden debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Information value: PassengerDiscountCodeOverridden status: 0 details: associatedDiscountCode: SNR data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v4/availability/search/simple: post: tags: - availability summary: 'Searches for availability with the simple availability search request. This request allows for easy setup for one way and round trip searches. If a property is not set, default values will be set instead just like they would in the full availability request. These defaults are what we consider a general optimized request. If these optimizations are not preferred the requester will need to opted out the filters on the availability simple request.' description: 'Note: It is advised to optimize the availability request with passing in at least one or more (ProductClass, TravelClass, FareTypes or ClassesOfService) so the response can be optimized as possible. This is even more recommended for mobile applications due to the nature of limited network capabilities. The default values that will be set unless specified: - TaxesAndFees = TaxesAndFeesRollupMode.None - SsrCollectionsMode = AvailabilitySsrCollectionsMode.None - Filters.FareInclusionType = AvailabilityType.Default - Filters.CompressionType = FareClassControl.LowestFareClass - Filters.Loyalty = LoyaltyFilter.MonetaryOnly - Filters.FlightType = FlightType.All - Filters.ExclusionType = AvailabilityFilter.ExcludeUnavailable - Filters.SortOptions = JourneySortKey.LowestFare,JourneySortKey.EarliestDeparture,JourneySortKey.ShortestTravelTime - Filters.ConnectionType = SoldAsConnectionType.None - Filters.MaxConnectingFlights = 0 - SearchDestinationMacs = false - SearchOriginMacs = false - Criteria.Filters.BundleControlFilter = BundleControlFilter.Disabled - NumberOfFaresPerJourney = 1 Note that the searchOriginMacs and searchDestinationMacs flags apply to both journeys when booking a round-trip journey with the simple availability endpoint. For example, if you set "searchOriginMacs" to "true" for a round trip from SLC-BOS and back, it will search for SLC MAC airports on the outbound (SLC > BOS) journey, and BOS MAC airports on the inbound (BOS > SLC) journey Criteria.Filters.IncludeServiceBundleSetCodes is marked as obsolete, and the use of BundleControlFilter is preferred. To specifically return bundle set codes which IncludeServiceBundleSetCodes has originally provided when set to true, use an enumeration value of BundleControlFilter.ReturnBundleSets for BundleControlFilter instead. The AvailabilityCriteriaFilter.FareInclusionType.NoPricing enumeration value, if set, will result in an availability response that does not include fares. The primary use case for this is in Move flows, but is being maintained on the main availability and rebook availability flows in case there are other use cases as well. GraphQL endpoint: availabilitySimplev4' operationId: nsk_v4_availability_search_simple_post requestBody: x-name: request description: The availability simple v2 search request. content: application/json: schema: $ref: '#/components/schemas/AvailabilitySimpleRequestv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' examples: Requested Passenger Discount Overridden Message: description: Example OSI Message when getting availability with a promotion code, no requested passenger discount, and the promotion code has a passenger discount associated with it. *NOTE*:This example *only* displays the message, however, the availability data will be populated in addition the given message. value: messages: - rawValue: 'A passenger discount code was found that is associated with the requested promotion code. The passenger discount code on the request has been override with the following associated discount code: SNR.' code: PassengerDiscountCodeOverridden debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Information value: PassengerDiscountCodeOverridden status: 0 details: associatedDiscountCode: SNR data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/availability/search/ssr: post: tags: - availability summary: 'Searches for availability with SSR prices with the full availability search request. This request allows for total control over the configuration. If a property is not set, default values will be set instead. These defaults are what we consider a general optimized request. If these optimizations are not preferred the requester will need to opt out of the filters on the availability request.' description: 'Note: This is an expensive call and should be used with appropriate cautions. It is advised to optimize the availability request with passing in at least one or more (ProductClass, TravelClass, FareTypes or ClassesOfService) so the response can be optimized as possible. This is even more recommended for mobile applications due to the nature of limited network capabilities. The default values that will be set unless specified: - AvailabilityWithSsrRequest.TaxesAndFees = TaxesAndFeesRollupMode.None - AvailabilityWithSsrRequest.Criteria.SsrCollectionsMode = AvailabilitySsrCollectionsMode.None - AvailabilityWithSsrRequest.Criteria.Filters.FareInclusionType = AvailabilityType.Default - AvailabilityWithSsrRequest.Criteria.Filters.CompressionType = FareClassControl.LowestFareClass - AvailabilityWithSsrRequest.Criteria.Filters.Loyalty = LoyaltyFilter.MonetaryOnly - AvailabilityWithSsrRequest.Criteria.Filters.FlightType = FlightType.All - AvailabilityWithSsrRequest.Criteria.Filters.ExclusionType = AvailabilityFilter.ExcludeUnavailable - AvailabilityWithSsrRequest.Criteria.Filters.SortOptions = JourneySortKey.LowestFare,JourneySortKey.EarliestDeparture,JourneySortKey.ShortestTravelTime - AvailabilityWithSsrRequest.Filters.ConnectionType = SoldAsConnectionType.None - AvailabilityWithSsrRequest.Criteria.Filters.MaxConnectingFlights = 0 - AvailabilityWithSsrRequest.Criteria.Stations.SearchDestinationMacs = false - AvailabilityWithSsrRequest.Criteria.Stations.SearchOriginMacs = false - AvailabilityWithSsrRequest.Criteria.Filters.BundleControlFilter = BundleControlFilter.Disabled - AvailabilityWithSsrRequest.NumberOfFaresPerJourney = 1 AvailabilityWithSsrRequest.Criteria.Filters.IncludeServiceBundleSetCodes is marked as obsolete, and the use of BundleControlFilter is preferred. To specifically return bundle set codes which IncludeServiceBundleSetCodes has originally provided when set to true, use an enumeration value of BundleControlFilter.ReturnBundleSets for BundleControlFilter instead. The AvailabilityCriteriaFilter.FareInclusionType.NoPricing enumeration value, if set, will result in an availability response that does not include fares. The primary use case for this is in Move flows, but is being maintained on the main availability and rebook availability flows in case there are other use cases as well. GraphQL endpoint: availabilityWithSsrv2' operationId: nsk_v2_availability_search_ssr_post requestBody: x-name: request description: The availability with SSR search request. content: application/json: schema: $ref: '#/components/schemas/AvailabilityWithSsrRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityWithSsrResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/baggage: post: tags: - baggage summary: Adds baggage to a booking stateless. description: 'Agent only. Requires the booking to be committed. If you have the booking in state you will need to re-retrieve it to see the added baggage. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: baggageAdd' operationId: dcs_v1_baggage_post requestBody: x-name: request description: A request to add bags to the given passenger. content: application/json: schema: $ref: '#/components/schemas/AddBaggageRequest' examples: Journey Bag Check-in: description: Example request for adding a bag to a booking. value: recordLocator: I3NTYF journeyKey: TlZ_NTYyNn4gfn5TTEN_MDcvMjYvMjAyNSAwNjowMH5ERU5_MDcvMjYvMjAyNSAwNzowMH5_Xk5WfjU2MjJ_IH5_REVOfjA3LzI2LzIwMjUgMDg6MDB_Qk9TfjA3LzI2LzIwMjUgMTQ6MDB_fg-- passengerKey: MCFBRFQ- iataIdentifier: 091 nonStandard: false allowBaggageOnNonHosted: true baggageInformation: type: BA20 manualBagTag: false osTag: SLC987654 weight: 10 weightType: 1 required: true x-position: 1 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Add Baggage Successful: description: Example when baggage is added successfully value: data: null Add Baggage Failed With Specific Error Message: description: Example when baggage is not added successfully because segment status is Closed/ClosedPending/Cancelled/BlockAllActivities. A 201 Created is still returned even though the baggage was not added. value: messages: - rawValue: 'The system has returned an error message for adding a bag with passenger key ''MCFBRFQ-'' and journey key ''TlZ_MjI0MX4gfn5TTEN_MDYvMjgvMjAyNCAxMzoxNX5ERU5_MDYvMjgvMjAyNCAxNTozMH5_Xk5WfiA3ODl_IH5_REVOfjA2LzI4LzIwMjQgMTY6MzB_Qk9TfjA2LzI4LzIwMjQgMjI6MDB_fg--''. The message is: ''Flight 2241 SLCBOS has been cancelled, request not processed.''.' code: dcs:Baggage:BaggageAddError debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: dcs:Baggage:BaggageAddError status: 1 details: journeyKey: TlZ_MjI0MX4gfn5TTEN_MDYvMjgvMjAyNCAxMzoxNX5ERU5_MDYvMjgvMjAyNCAxNTozMH5_Xk5WfiA3ODl_IH5_REVOfjA2LzI4LzIwMjQgMTY6MzB_Qk9TfjA2LzI4LzIwMjQgMjI6MDB_fg-- passengerKey: MCFBRFQ- data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Journey Key Error: description: Example error when journey key is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: journeyKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'JourneyKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Baggage Type Code Error: description: Example error when baggage type code is invalid. value: errors: - id: 1a68ef3e-44b5-08d4-9395-e69695467a5d code: dcs:Baggage:InvalidBaggageTypeCode message: dcs:Baggage:InvalidBaggageTypeCode type: Validation details: null rawMessage: The baggage type code 'BA20' is not valid or is inactive for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Add Baggage Failure Without Specific Message: description: Example error when add baggage fails in New Skies without a specific error message. value: errors: - id: 693b6295-6ae8-a005-9f1e-1e1d1600d573 code: dcs:Exceptions:CreateFailed message: dcs:Exceptions:CreateFailed type: Validation details: null rawMessage: Attempted create of object 'AddBaggageRequest' has failed. Please verify this object does not already exist. 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 Add Baggage Failure With Specific Message: description: Example error when add baggage fails in New Skies with a specific error message. value: errors: - id: 693b6295-6ae8-a005-9f1e-1e1d1600d573 code: dcs:Exceptions:CreateFailed message: dcs:Exceptions:CreateFailed type: Validation details: null rawMessage: Attempted create of object 'AddBaggageRequest' has failed. Please verify this object does not already exist. 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. messages: - rawValue: 'The system has returned an error message for adding a bag with passenger key ''MCFBRFQ-'' and journey key ''TlZ_MjI0MX4gfn5TTEN_MDYvMjgvMjAyNCAxMzoxNX5ERU5_MDYvMjgvMjAyNCAxNTozMH5_Xk5WfiA3ODl_IH5_REVOfjA2LzI4LzIwMjQgMTY6MzB_Qk9TfjA2LzI4LzIwMjQgMjI6MDB_fg--''. The message is: ''Flight 2241 SLCBOS has been cancelled, request not processed.''.' code: dcs:Baggage:BaggageAddError debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: dcs:Baggage:BaggageAddError status: 1 details: journeyKey: TlZ_MjI0MX4gfn5TTEN_MDYvMjgvMjAyNCAxMzoxNX5ERU5_MDYvMjgvMjAyNCAxNTozMH5_Xk5WfiA3ODl_IH5_REVOfjA2LzI4LzIwMjQgMTY6MzB_Qk9TfjA2LzI4LzIwMjQgMjI6MDB_fg-- passengerKey: MCFBRFQ- data: null '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true delete: tags: - baggage summary: Sets the 'Removed' status for a bag for a booking stateless. description: 'Agent only. Requires the booking to be committed. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: baggageRemove' operationId: dcs_v1_baggage_delete requestBody: x-name: request description: A request to set bag status as 'Removed' for the provided passenger bag. content: application/json: schema: $ref: '#/components/schemas/RemoveBaggageRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v2/baggage: post: tags: - baggage summary: Adds baggage to a booking stateless. description: 'Agent only. Requires the booking to be committed. If you have the booking in state you will need to re-retrieve it to see the added baggage. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: baggageAddv2' operationId: dcs_v2_baggage_post requestBody: x-name: request description: A request to add bags to the given passenger. content: application/json: schema: $ref: '#/components/schemas/AddBaggageRequest' examples: Journey Bag Check-in: description: Example request for adding a bag to a booking. value: recordLocator: I3NTYF journeyKey: TlZ_NTYyNn4gfn5TTEN_MDcvMjYvMjAyNSAwNjowMH5ERU5_MDcvMjYvMjAyNSAwNzowMH5_Xk5WfjU2MjJ_IH5_REVOfjA3LzI2LzIwMjUgMDg6MDB_Qk9TfjA3LzI2LzIwMjUgMTQ6MDB_fg-- passengerKey: MCFBRFQ- iataIdentifier: 091 nonStandard: false allowBaggageOnNonHosted: true baggageInformation: type: BA20 manualBagTag: false osTag: SLC987654 weight: 10 weightType: 1 required: true x-position: 1 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Add Baggage Successful: description: Example when baggage is added successfully value: data: null '400': description: Adding bag failed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Journey Key Error: description: Example error when journey key is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: journeyKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'JourneyKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Baggage Type Code Error: description: Example error when baggage type code is invalid. value: errors: - id: 1a68ef3e-44b5-08d4-9395-e69695467a5d code: dcs:Baggage:InvalidBaggageTypeCode message: dcs:Baggage:InvalidBaggageTypeCode type: Validation details: null rawMessage: The baggage type code 'BA20' is not valid or is inactive for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null All Bags Fail Without Specific Message: description: Example error when add baggage fail in New Skies without a specific error message. value: errors: - id: 693b6295-6ae8-a005-9f1e-1e1d1600d573 code: dcs:Exceptions:CreateFailed message: dcs:Exceptions:CreateFailed type: Validation details: null rawMessage: Attempted create of object 'AddBaggageRequest' has failed. Please verify this object does not already exist. 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 Add Baggage Failure With Specific Message: description: Example error when add baggage fails in New Skies with a specific error message. value: errors: - id: 693b6295-6ae8-a005-9f1e-1e1d1600d573 code: dcs:Exceptions:CreateFailed message: Flight 2241 SLCBOS has been cancelled, request not processed. type: Error details: journeyKey: TlZ_NTYxNH4gfn5TTEN_MDYvMjgvMjAyNCAwMzowMH5ERU5_MDYvMjgvMjAyNCAwNDowMH5_Xk5WfjU2MTV_IH5_REVOfjA2LzI4LzIwMjQgMDg6MDB_Qk9TfjA2LzI4LzIwMjQgMTM6MDB_fg-- passengerKey: MCFBRFQ- errorMessage: Flight 2241 SLCBOS has been cancelled, request not processed. rawMessage: Flight 2241 SLCBOS has been cancelled, request not processed. 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: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/baggage/byLegKey: delete: tags: - baggage summary: Sets the 'Removed' status for a bag for a booking stateless, by leg key. description: 'Agent only. Requires the booking to be committed. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. All downline legs and segments will have the bag status marked as `Removed` as well. If you want to remove the bag for a whole journey, just pass in the first leg key. GraphQL endpoint: baggageRemoveByLegKey' operationId: dcs_v1_baggage_byLegKey_delete requestBody: x-name: request description: A request to set bag status as 'Removed' for the provided passenger bag. content: application/json: schema: $ref: '#/components/schemas/RemoveBaggageByLegKeyRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid passenger key error: description: Example error when passenger key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'PassengerKey' with value 'tW' is invalid. type: Validation details: passengerKey: tW 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 Invalid leg key error: description: Example error when leg key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'LegKey' with value '76oyA0KoZ0gsjHX' is invalid. type: Validation details: legKey: 76oyA0KoZ0gsjHX 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 Invalid baggage key error: description: Example error when baggage key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'BaggageKey' with value 'upvbqtl' is invalid. type: Validation details: baggageKey: upvbqtl 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 Invalid record locator error: description: Example error when the record locator invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'RecordLocator' with value 'n02' is invalid. type: Validation details: recordLocator: n02 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: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/baggage/checkIn: put: tags: - baggage summary: Performs an update and checks-in an individual baggage item for a specific passenger. description: 'If the journey key is set on the request, the request will process all segments associated with the journey, and will ignore the segment key value. The baggage type code can only be updated if the baggage weight is changed as well, and if the baggage type code is a valid, active baggage type in the current environment. Please note, this call does NOT sync with the booking baggage allowances and usages. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: baggageSet' operationId: dcs_v1_baggage_checkIn_put requestBody: x-name: request description: The passenger bag edit request. content: application/json: schema: $ref: '#/components/schemas/PassengerBagEditRequest' examples: Journey Bag Check-in: description: Example request for checking in a bag for a journey value: allowBaggageOnNonHosted: true weight: 20 processAsIatci: false baggageCount: 2 baggageTypeCode: 1BAG segmentKey: null journeyKey: TlZ_NTYyNn4gfn5TTEN_MDcvMjYvMjAyNSAwNjowMH5ERU5_MDcvMjYvMjAyNSAwNzowMH5_Xk5WfjU2MjJ_IH5_REVOfjA3LzI2LzIwMjUgMDg6MDB_Qk9TfjA3LzI2LzIwMjUgMTQ6MDB_fg-- passengerKey: MCFBRFQ- baggageKey: MDAyODA0MTMzMQ-- recordLocator: I3NTYF Segment Bag Check-in: description: Example request for checking in a bag for a segment value: allowBaggageOnNonHosted: true weight: 21 processAsIatci: false baggageCount: 2 baggageTypeCode: 1BAG segmentKey: TlZ_MjAwNH4gfn5TTEN_MDgvMDEvMjAyNSAwMTo1OX5KRkt_MDgvMDEvMjAyNSAwNDowMH5_ journeyKey: null passengerKey: MCFBRFQ- baggageKey: MDg4ODA1NTEzMA-- recordLocator: T4VBGC required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Journey Key Error: description: Example error when journey key is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: journeyKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'JourneyKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Journey and Segment Keys Not Provided: description: Example error when neither journey key or segment key are provided. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: dcs:Baggage:JourneyOrSegmentKeyRequired message: dcs:Baggage:JourneyOrSegmentKeyRequired type: Validation details: null rawMessage: Either the journey key or the segment key is required for this operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Changing Type Code But Not Weight: description: Example error when the baggage type code cannot be changed because the baggage weight did not change. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: ndcs:Baggage:UnableToChangeBaggageTypeCode message: dcs:Baggage:UnableToChangeBaggageTypeCode type: Validation details: null rawMessage: The baggage type code cannot be changed because the edit request does not have a change for the baggage weight. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Baggage Type Code Error: description: Example error when baggage type code is invalid. value: errors: - id: 1a68ef3e-44b5-08d4-9395-e69695467a5d code: dcs:Baggage:InvalidBaggageTypeCode message: dcs:Baggage:InvalidBaggageTypeCode type: Validation details: null rawMessage: The baggage type code 'BA20' is not valid or is inactive for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid leg status error: description: Example error when leg status is invalid. value: errors: - id: null code: nsk:Baggage:BaggageCheckinFailed message: nsk:Baggage:BaggageCheckinFailed type: Validation details: segmentKey: 9SkFNRegdQRYuQ3YfA2g9 legKey: 9SkFNReg flightNumber: '1234' origin: JFK destination: LAX legStatus: Closed rawMessage: Flight must be open to checkin baggage. One or more legs on the given journey/segment is not open. 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: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/dcs/v2/baggage/checkIn: put: tags: - baggage summary: Performs an update and checks-in an individual baggage item for a specific passenger. description: 'If the journey key is set on the request, the request will process all segments associated with the journey, and will ignore the segment key value. The baggage type code can only be updated if the baggage weight is changed as well, and if the baggage type code is a valid, active baggage type in the current environment. Please note, this call does NOT sync with the booking baggage allowances and usages. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: baggageSetv2' operationId: dcs_v2_baggage_checkIn_put requestBody: x-name: request description: The passenger bag edit request. content: application/json: schema: $ref: '#/components/schemas/PassengerBagEditRequest' examples: Journey Bag Check-in: description: Example request for checking in a bag for a journey value: allowBaggageOnNonHosted: true weight: 20 processAsIatci: false baggageCount: 2 baggageTypeCode: 1BAG segmentKey: null journeyKey: TlZ_NTYyNn4gfn5TTEN_MDcvMjYvMjAyNSAwNjowMH5ERU5_MDcvMjYvMjAyNSAwNzowMH5_Xk5WfjU2MjJ_IH5_REVOfjA3LzI2LzIwMjUgMDg6MDB_Qk9TfjA3LzI2LzIwMjUgMTQ6MDB_fg-- passengerKey: MCFBRFQ- baggageKey: MDAyODA0MTMzMQ-- recordLocator: I3NTYF Segment Bag Check-in: description: Example request for checking in a bag for a segment value: allowBaggageOnNonHosted: true weight: 21 processAsIatci: false baggageCount: 2 baggageTypeCode: 1BAG segmentKey: TlZ_MjAwNH4gfn5TTEN_MDgvMDEvMjAyNSAwMTo1OX5KRkt_MDgvMDEvMjAyNSAwNDowMH5_ journeyKey: null passengerKey: MCFBRFQ- baggageKey: MDg4ODA1NTEzMA-- recordLocator: T4VBGC required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '207': description: "\n Multi Status. Some leg keys were invalid\ \ or could not be retrieved. See the response messages for\n \ \ details.\n " content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Partial Failure - a Segment is Closed.: description: Example response of a partially-successful bag check in for multiple segments. The failed check-ins will each have a warning message. value: messages: - rawValue: 'The system has returned an error message for bag update with passenger key ''MCFBRFQ-'', segment key ''9SkFNRegdQRYuQ3YfA2g9'', and baggage key ''MDAyODA0MTMzOA--''. The message is: ''Cannot print bag tag (0028041338); Invalid baggage status.''.' code: nsk:Baggage:BaggageUpdateError debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: nsk:Baggage:BaggageUpdateError status: 1 details: segmentKey: 9SkFNRegdQRYuQ3YfA2g9 legKey: 9SkFNReg flightNumber: '1234' origin: JFK destination: LAX legStatus: Closed data: null Partial Failure - a Segment is Closed. The failed check-ins will each have a warning message.: description: Example response of a partially-successful bag check in for multiple segments. value: messages: - rawValue: Flight must be open to checkin baggage. One or more legs on the given journey/segment is not open. code: nsk:Baggage:BaggageCheckinFailed debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: nsk:Baggage:BaggageCheckinFailed status: 1 details: segmentKey: 9SkFNRegdQRYuQ3YfA2g9 legKey: 9SkFNReg flightNumber: '1234' origin: JFK destination: LAX legStatus: Closed data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Journey Key Error: description: Example error when journey key is invalid. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: journeyKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'JourneyKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Journey and Segment Keys Not Provided: description: Example error when neither journey key or segment key are provided. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: dcs:Baggage:JourneyOrSegmentKeyRequired message: dcs:Baggage:JourneyOrSegmentKeyRequired type: Validation details: null rawMessage: Either the journey key or the segment key is required for this operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Changing Type Code But Not Weight: description: Example error when the baggage type code cannot be changed because the baggage weight did not change. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: dcs:Baggage:UnableToChangeBaggageTypeCode message: dcs:Baggage:UnableToChangeBaggageTypeCode type: Validation details: null rawMessage: The baggage type code cannot be changed because the edit request does not have a change for the baggage weight. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Baggage Type Code Error: description: Example error when baggage type code is invalid. value: errors: - id: 1a68ef3e-44b5-08d4-9395-e69695467a5d code: dcs:Baggage:InvalidBaggageTypeCode message: dcs:Baggage:InvalidBaggageTypeCode type: Validation details: null rawMessage: The baggage type code 'BA20' is not valid or is inactive for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Closed flight: description: Example error when all baggage check-ins failed due to closed flight. value: errors: - id: null code: nsk:Baggage:BaggageCheckinFailed message: nsk:Baggage:BaggageCheckinFailed type: Validation details: segmentKey: 9SkFNRegdQRYuQ3YfA2g9 legKey: 9SkFNReg flightNumber: '1234' origin: JFK destination: LAX legStatus: Closed rawMessage: Flight must be open to checkin baggage. All legs on the given journey/segment are not open. 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: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/bagTag/printers: get: tags: - bagTag summary: Gets the bag tag printers. description: 'This information is retrieved based on the logged in user''s location. If a location is not set up, the returned information will be the default printers configured in printers.xml from UTL\Resource Management. GraphQL endpoint: bagTagPrinters' operationId: dcs_v1_bagTag_printers_get responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBagTagPrinter' /api/dcs/v2/boarding/{recordLocator}/legs/{legKey}/passengers/{passengerKey}: post: tags: - boarding summary: 'Boards a passenger on a specific leg. If the leg is NOT a part of a change of gauge flight, it is recommended to board by segment instead.' description: 'If there are downstream legs that are not boarded on the segment and the flight is not a change of gauge, the rest of the legs will be boarded as well. For example, if you have a three leg segment and you board the middle leg, the last leg will also be boarded and the first leg will not be boarded. This endpoint will return information like a GET because there may be necessary security information on the response. To check the lift status of the boarded leg, please use /api/nsk/manifest/{legKey}. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: boardByLegv2' operationId: dcs_v2_boarding_recordLocator_legs_legKey_passengers_passengerKey_post parameters: - name: recordLocator in: path required: true description: The record locator for the booking. schema: type: string x-position: 1 - name: legKey in: path required: true description: The leg key to board. schema: type: string x-position: 2 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 3 requestBody: x-name: request description: The board passenger request. content: application/json: schema: $ref: '#/components/schemas/BoardPassengerBaseRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoardPassengerResponsev2' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/boarding/{recordLocator}/legs/{legKey}/passengers/{passengerKey}: delete: tags: - boarding summary: Unboards a passenger on a specific leg. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: unboardByLeg' operationId: dcs_v1_boarding_recordLocator_legs_legKey_passengers_passengerKey_delete parameters: - name: recordLocator in: path required: true description: The record locator for the booking. schema: type: string x-position: 1 - name: legKey in: path required: true description: The leg key to board. schema: type: string x-position: 2 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v2/boarding/{recordLocator}/segments/{segmentKey}/passengers/{passengerKey}: post: tags: - boarding summary: 'Boards a passenger on a specific segment. A segment should not be boarded if it is a change of gauge flight.' description: 'If an attempt at boarding a segment is made with a change of gauge flight, only the first leg of that segment will be boarded. The endpoint will return that the process was successful, but the full segment with legs was not boarded. This can be checked using the endpoint listed below. This endpoint will return information like a GET because there may be necessary security information on the response. To check the lift status of the boarded segment please use /api/nsk/v1/bookings/checkin/{recordLocator}/segments/{segmentKey}/status. That endpoint can be used after boarding as well because it retrieves the lift status of the segment. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: boardBySegmentv2' operationId: dcs_v2_boarding_recordLocator_segments_segmentKey_passengers_passengerKey_post parameters: - name: recordLocator in: path required: true description: The record locator for the booking. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key to board. schema: type: string x-position: 2 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 3 requestBody: x-name: request description: The board passenger request. content: application/json: schema: $ref: '#/components/schemas/BoardPassengerBaseRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoardPassengerResponsev2' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/boarding/legs/{legKey}/passengers: delete: tags: - boarding summary: Unboards all passengers on a leg. description: 'If a warning message is present, check the lift status of the passengers. A passenger will come back as not being unboarded if they are not checked in and boarded. GraphQL endpoint: unboardAllPassengers' operationId: dcs_v1_boarding_legs_legKey_passengers_delete parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v2/boarding/legs/{legKey}/passengers: post: tags: - boarding summary: Boards all passengers on a specific leg. description: 'If there are downstream legs that are not boarded on the segment and the flight is not a change of gauge, the rest of the legs will be boarded as well. For example, if you have a three leg segment and you board the middle leg, the last leg will also be boarded and the first leg will not be boarded. If the flight is a change of gauge, then only the leg requested will be boarded. To check the lift status of the boarded leg, please use /api/nsk/manifest/bookings/{recordLocator}/legs/{legKey}. GraphQL endpoint: boardAllByLegv2' operationId: dcs_v2_boarding_legs_legKey_passengers_post parameters: - name: legKey in: path required: true description: The leg key to board. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBoardAllPassengerResponsev2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking: get: tags: - booking summary: Get the current booking in state. description: 'Note: To add a booking comment please use api/nsk/v3/booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: booking' operationId: nsk_v1_booking_get responses: '200': description: OK. The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:12.9400815Z' createdDate: '2026-07-09T05:55:12.9400817Z' expirationDate: '2026-07-12T05:55:12.940082Z' modifiedDate: '2026-07-09T05:58:12.9400846Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:12.9401375Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:12.9402234Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:12.9402276Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:12.9402642+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:12.9402306Z' number: P31322423218 issuedDate: '2025-07-09T05:55:12.940236Z' gender: 1 dateOfBirth: '2025-07-09T05:55:12.9402364Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:12.9404736Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:12.9402665Z' number: P31322423218 issuedDate: '2016-07-09T05:55:12.9402666Z' gender: 1 dateOfBirth: '2002-07-09T05:55:12.9402667Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:12.9403844Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:12.9407477Z' departure: '2026-07-09T05:55:12.9407478Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:12.9407477Z' departure: '2026-07-09T05:55:12.9407478Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:12.9404781Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:12.9404793Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:12.9404795Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:12.9404798Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:12.94048Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:12.9405003Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:12.9407349Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:12.9407372Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:12.9407413Z' actualOnBlockTime: '2026-07-10T05:55:12.940742Z' actualTouchDownTime: '2026-07-11T05:55:12.9407422Z' airborneTime: '2026-07-10T08:55:12.9407424Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:12.940743Z' estimated: '2026-07-09T05:45:12.9407431Z' standardArrivalTime: '2026-07-10T05:55:12.9407433Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:12.9407477Z' departure: '2026-07-09T05:55:12.9407478Z' legInfo: departureTimeUtc: '2026-07-09T12:55:12Z' arrivalTimeUtc: '2026-07-10T10:55:12Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:12.9407451Z' departureTime: '2026-07-09T05:55:12.9407451Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:12.9407505Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:12.9408301Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:12.9408487Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:12.94085Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:12.9408528Z' transactionCode: TRANSACTION dcc: rateId: 4c59d768-b5e7-4217-822d-92bbdf7aa78c currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:12.9409321Z' modifiedDate: '2026-07-09T06:00:12.9409323Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:12.9413975Z' beginLocation: SLC endDate: '2026-07-16T05:55:12.9414171Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:12.941594Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:12.9416424Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:12.9421047Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:12.9423547Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:12.9424383Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:12.9425326Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:12.9437007Z' modified: '2026-07-09T06:25:12.9437187Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: 2a727ff3-4f5a-4d07-a83d-6e617e656d29 collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No booking in state: description: There is no booking to retrieve in the session state. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking: post: tags: - booking summary: Commits stateful changes made and processes the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This endpoint can be configured to allow for the newly created record locator to be returned in the response. This is an API value that needs to be set in configuration, NskSystemOptions.ReturnPnrOnv3BookingPost = true. Default behavior is to not return the new record locator. This will require a SNOW ticket to change. GraphQL endpoint: bookingCommitv3' operationId: nsk_v3_booking_post requestBody: x-name: request description: Commit request. content: application/json: schema: $ref: '#/components/schemas/CommitRequestv2' required: true x-position: 1 responses: '201': description: Committed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCommitBookingResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Duplicate passenger names: description: Example error with 2 passengers with identical names. value: errors: - id: null code: nsk-server:DuplicatePassengerName message: 'Booking is not allowed to have two passengers with the same name: Derek Holmes' type: Error details: null 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 Modified Booking: description: Booking was modified since last viewed, please reload. value: errors: - id: null code: nsk-server:BookingWasModified message: Booking ZZZ123 has been modified by another user. type: Error details: null 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 Class Not Available: description: The class of service has sold out since the shopping request was made. value: errors: - id: null code: nsk-server:ClassNotAvailable message: The requested class of service is sold out. type: Error details: null 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 SSR Not Available: description: The SSR has sold out since the ssr availability request was made. value: errors: - id: null code: nsk-server:SSRNotAvailable message: SSR PS is not available on flight FR1123 SLC-DEN for passenger John Smith. type: Error details: null 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 Hold Not Allowed Error: description: Example error when Committing Booking while Hold Date Override is disabled. value: errors: - id: null code: nsk:Booking:HoldNotAllowed message: A booking hold is not allowed for this booking. Verify that the booking has journeys, balance due, or override is configured. type: Error details: null 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 Hold Greater Than Allowed: description: Example error when Committing Booking with Hold Date Greater Than allowed. value: errors: - id: null code: nsk-server:HoldBookingNotAllowed message: The selected hold date is not allowed. The value, 11/14/2023 00:00:00, and is greater than the allowed hold date of 11/10/2023 01:01:00. type: Error details: null 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 First passenger is not allowed to be TBA and is set as TBA: description: Example error when first passenger is not allowed to be TBA and its first or last name is set to "TBA". Please see GET /settings/booking/passenger for the configuration. value: errors: - id: null code: nsk:GroupBooking:GroupNameUpdateNotAllowed message: The first Pax is not allowed to be listed as TBA. type: Validation details: null rawMessage: The first Pax is not allowed to be listed as TBA. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Passengers are not allowed to be TBA and at least one passenger is set to TBA: description: Example error when passengers are not allowed to be TBA and at least one passenger's first or last name is set to "TBA". Please see GET /settings/booking/passenger for the configuration. value: errors: - id: null code: nsk:GroupBooking:GroupNameUpdateNotAllowed message: No passengers are allowed to be listed as TBA. type: Validation details: null rawMessage: No passengers are allowed to be listed as TBA. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null put: tags: - booking summary: Commits stateful changes made and processes the booking. description: 'Only archived bookings can use the `Archive` comment type. If the booking in state is archived, only the comments will be acknowledged by New Skies. All other filled in fields in the request will be ignored. If AllowConcurrentChanges is set to true, a merge between concurrent changes between multiple sessions will be performed before committing the booking. New Skies refers to this as MergeAndCommit2. We recommend only setting this flag to true for cases where concurrent booking changes are highly possible (e.g. multiple sessions making changes to the same booking right before checking-in). IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingCommitv3' operationId: nsk_v3_booking_put parameters: - name: allowConcurrentChanges in: query description: Flag to allow concurrent booking changes between multiple sessions. schema: type: boolean x-position: 2 requestBody: x-name: request description: Commit request. content: application/json: schema: $ref: '#/components/schemas/CommitRequestv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Hold Date Changed: description: Example response when hold date is changed. value: messages: - rawValue: The hold date has changed from 10/10/2023 08:50 to 10/25/2023 00:00. code: '' debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: HoldDateChanged value: null status: 0 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Duplicate passenger names: description: Example error with 2 passengers with identical names. value: errors: - id: null code: nsk-server:DuplicatePassengerName message: 'Booking is not allowed to have two passengers with the same name: Derek Holmes' type: Error details: null 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 Modified Booking: description: Booking was modified since last viewed, please reload. value: errors: - id: null code: nsk-server:BookingWasModified message: Booking ZZZ123 has been modified by another user. type: Error details: null 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 Class Not Available: description: The class of service has sold out since the shopping request was made. value: errors: - id: null code: nsk-server:ClassNotAvailable message: The requested class of service is sold out. type: Error details: null 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 SSR Not Available: description: The SSR has sold out since the ssr availability request was made. value: errors: - id: null code: nsk-server:SSRNotAvailable message: SSR PS is not available on flight FR1123 SLC-DEN for passenger John Smith. type: Error details: null 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 Hold Not Allowed Error: description: Example error when Committing Booking while Hold Date Override is disabled. value: errors: - id: null code: nsk:Booking:HoldNotAllowed message: A booking hold is not allowed for this booking. Verify that the booking has journeys, balance due, or override is configured. type: Error details: null 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 Hold Greater Than Allowed: description: Example error when Committing Booking with Hold Date Greater Than allowed. value: errors: - id: null code: nsk-server:HoldBookingNotAllowed message: The selected hold date is not allowed. The value, 11/14/2023 00:00:00, and is greater than the allowed hold date of 11/10/2023 01:01:00. type: Error details: null 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 '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/addons/{addOnKey}/payments: get: tags: - booking/addons summary: Gets a specific add-on's allowed payment methods. description: 'If the add on''s payment required flag is set to true, this endpoint will return the allowed payment options for the add on. If set to false, null will be returned. GraphQL endpoint: addOnPaymentAllowed' operationId: nsk_v1_booking_addons_addOnKey_payments_get parameters: - name: addOnKey in: path required: true description: The unique add on key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAddOnAllowedPayments' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/addons summary: Adds a payment to a specific add-on on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: addOnPaymentAdd' operationId: nsk_v1_booking_addons_addOnKey_payments_post parameters: - name: addOnKey in: path required: true description: The unique add on key. schema: type: string x-position: 1 requestBody: x-name: request description: The order payment to be added. content: application/json: schema: $ref: '#/components/schemas/OrderPaymentBase' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/addons/payments: get: tags: - booking/addons summary: Gets all the available add-ons allowed payment methods for all the add-ons on the booking in state. description: 'GraphQL endpoint: addOnPayment' operationId: nsk_v1_booking_addons_payments_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndAddOnAllowedPayments' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/addons/sync: put: tags: - booking/addons summary: Syncs the prices of the Travel Commerce addons. description: 'This endpoint should be called prior to displaying the total booking cost and collecting payment for Travel Commerce items. It will trigger New Skies to query Travel Commerce for the items in the cart. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: addOnSyncPriceSet' operationId: nsk_v1_booking_addons_sync_put responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/baggageAllowances: get: tags: - booking summary: 'Gets the baggage allowances for the current booking in state. Baggage usage details will only be returned if includeUsageDetails is flagged true AND the allowance behavior is NOT Default.' description: 'GraphQL endpoint: baggageAllowances' operationId: nsk_v1_booking_baggageAllowances_get parameters: - name: includeUsageDetails in: query description: "If true, the baggage allowance usage details will be populated\ \ in the response.\nIncluding these details adds processing overhead, so\ \ set this only when absolutely necessary.\nDefaults to `false`, not include\ \ usage details.\n " schema: type: boolean nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfBaggageAllowance' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/baggageAllowances/external: post: tags: - booking summary: Gets the third-party baggage allowance calculations for the current booking in state. description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. GraphQL endpoint: baggageAllowancesExternal' operationId: nsk_v1_booking_baggageAllowances_external_post requestBody: x-name: request description: "External baggage allowance request.\n " content: application/json: schema: $ref: '#/components/schemas/ExternalBaggageAllowanceRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfExternalBaggageAllowanceResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/boardingpasses/journey/{journeyKey}: post: tags: - booking/boardingpasses summary: Retrieves the version of the boarding passes based on a specific journey. description: 'GraphQL endpoint: boardingPassByJourneyv3' operationId: nsk_v3_booking_boardingpasses_journey_journeyKey_post parameters: - name: journeyKey in: path required: true description: The journey to retrieve boarding passes for. schema: type: string x-position: 1 requestBody: x-name: request description: The passenger/segment filter request. content: application/json: schema: $ref: '#/components/schemas/BoardingPassFilterRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoardingPassesCollectionv2' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/boardingpasses/m2d/journey/{journeyKey}: post: tags: - booking/boardingpasses summary: 'Retrieves the specific journeys boarding passes using the M2D barcode type. This endpoint will only give a single barcode back even if the journey contains multiple segments. Note that if the journey has only one segment the M2D barcode will look just like the S2D barcode.' description: 'GraphQL endpoint: boardingPassByJourneyForPassengerM2D' operationId: nsk_v1_booking_boardingpasses_m2d_journey_journeyKey_post parameters: - name: journeyKey in: path required: true description: The specific journey to get boarding passes for. schema: type: string x-position: 1 requestBody: x-name: request description: The boarding pass passenger filter request. content: application/json: schema: $ref: '#/components/schemas/BoardingPassPassengerFilterRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoardingPassesM2D' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/boardingpasses/s2d/journey/{journeyKey}: post: tags: - booking/boardingpasses summary: 'Retrieves the specific journeys boarding passes for each segment using the S2D barcode type. This endpoint will provide a single barcode for each segment.' description: 'GraphQL endpoint: boardingPassByJourneyForPassengerS2D' operationId: nsk_v1_booking_boardingpasses_s2d_journey_journeyKey_post parameters: - name: journeyKey in: path required: true description: The specific journey to get boarding passes for. schema: type: string x-position: 1 requestBody: x-name: request description: The boarding pass passenger filter request. content: application/json: schema: $ref: '#/components/schemas/BoardingPassPassengerFilterRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoardingPassesS2D' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/boardingpasses/segment/{segmentKey}: post: tags: - booking/boardingpasses summary: Retrieves the version of the boarding passes based on a specific segment. description: 'GraphQL endpoint: boardingPassBySegmentv3' operationId: nsk_v3_booking_boardingpasses_segment_segmentKey_post parameters: - name: segmentKey in: path required: true description: The segment to retrieve boarding passes for. schema: type: string x-position: 1 requestBody: x-name: request description: The passenger filter request content: application/json: schema: $ref: '#/components/schemas/BoardingPassPassengerFilterRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoardingPassesCollectionv2' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/bundle/availability: post: tags: - booking summary: Retrieves the bundle and ssr availability for the booking in-state. description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. GraphQL endpoint: bookingBundleAvailability' operationId: nsk_v1_booking_bundle_availability_post requestBody: x-name: request description: The bundle availability request. content: application/json: schema: $ref: '#/components/schemas/BundleAvailabilityRequest' required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleAvailability' /api/nsk/v1/booking/checkin/journey/{journeyKey}: delete: tags: - booking/checkin summary: Removes the checkin status of passengers for a specific journey in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkinByJourneyDelete' operationId: nsk_v1_booking_checkin_journey_journeyKey_delete parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/checkin/journey/{journeyKey}: post: tags: - booking/checkin summary: Checks in a collection of passengers to a specific journey in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` - When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages` is set to true. - When debug mode is disabled, warning and error messages will be returned to agents only if the `SystemOptions.HideErrorMessages` is set to false. GraphQL endpoint: checkinByJourneyAddv3' operationId: nsk_v3_booking_checkin_journey_journeyKey_post parameters: - name: journeyKey in: path required: true description: The journey key of the segments to checkin. schema: type: string x-position: 1 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequestv3' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Check-in Successful: description: Example when check-in is successful. value: data: null Checkin Valid with displaying warning message to agents.: description: Example message when check in requirements are met, but there are still travel documents required. This requires Digital API configuration to be set such that warning messages can be returned to agents only when debug is turned off. value: messages: - code: CheckinPassengerWarning type: Warning value: 'AUT TEST Authorization Response Free Text 8501:AU:OK TO BOARD Documents are required for this flight.' status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null Checkin Valid with a masked warning message.: description: Example message when check in requirements are met, but there are still travel documents required. This is what non-agents will see regardless of Digital API configuration for displaying warning messages when debug is off.This is also what an agent would see if the corresponding API configuration is not set to allow warning messages to be shown. value: messages: - code: CheckinPassengerWarning type: Warning value: CheckinPassengerWarning status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Checkin Invalid: description: Example error when check in requirements are not met. The /requirements endpoint should be called before attempting a checkin. value: errors: - id: null code: nsk:Checkin:Invalid message: nsk:Checkin:Invalid type: Validation details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Checkin request is invalid. Please refer to checkin requirements for more details. 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 Seat Missing: description: In this example the optional request parameter `seatsRequired` was set to true. One passenger had a seat assigned and one did not. value: errors: - id: null code: nsk:Checkin:TypeID:1223 message: nsk:Checkin:TypeID:1223 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Baggins/Bilbo missing seat assignments on flight number 2452. 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 Inhibited: description: In this example the passenger meets all the requirements but is inhibited due to government security. value: errors: - id: null code: nsk:Checkin:TypeID:3096 message: nsk:Checkin:TypeID:3096 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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. - id: null code: nsk:Checkin:TypeID:3088 message: nsk:Checkin:TypeID:3088 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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 Missing verified document with agent visible error message: description: This example shows both the expected response when a passenger is missing verified documents, as well as what a logged-in agent would see if the API configuration is set correctly. This is an example response when debug mode is turned off. value: errors: - id: null code: nsk:Checkin:TypeID:1236 message: Baggins/Bilbo missing verified documents. type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ 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 '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/checkin/journey/{journeyKey}/requirements: get: tags: - booking/checkin summary: Gets the checkin pre-validation requirements for a specific journey. description: 'GraphQL endpoint: checkinByJourneyRequirementsv2' operationId: nsk_v2_booking_checkin_journey_journeyKey_requirements_get parameters: - name: journeyKey in: path required: true description: The journey key to be pre validate checkin with. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirementsv2' examples: Valid Response No Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: documentsOnFile: - P - V governmentDocumentInstances: - governmentInstance: USDHS numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I - group: 5 documentTypeCode: M verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true - governmentInstance: CBSA numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true isValid: true addressRequirements: isValid: false addressesOnFile: - Address1 unhandledAddresses: - Address2 invalidSsrs: null requiredSsrs: null restrictions: null isValid: true governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 cbsa: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: CBSA messageType: null minVerifiedDocumentCount: 1 restrictions: null isValid: true Response with Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: null addressRequirements: null invalidSsrs: null requiredSsrs: null restrictions: - restriction: 12 description: Missing Documents - restriction: 1 description: Missing Destination Address isValid: false governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 restrictions: - 4 isValid: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements: get: tags: - booking/checkin summary: Gets the checkin pre-validation requirements for a specific journey. description: 'GraphQL endpoint: checkinByJourneyRequirements' operationId: nsk_v1_booking_checkin_journey_journeyKey_requirements_get parameters: - name: journeyKey in: path required: true description: The journey key to be pre validate checkin with. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirements' examples: Not Paid In Full: description: Example partial response showing that the payment is due before check in value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 4 Closed: description: Example partial response showing that the check in is closed which is common if its outside of the configured check in window. value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 0 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/checkin/journey/{journeyKey}/status: get: tags: - booking/checkin summary: Gets the passengers lift status for a specific journey based on the booking in state. description: 'GraphQL endpoint: checkinByJourneyStatus' operationId: nsk_v1_booking_checkin_journey_journeyKey_status_get parameters: - name: journeyKey in: path required: true description: The journey to check lift statuses. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/checkin/segment/{segmentKey}: delete: tags: - booking/checkin summary: Removes the checkin status of passengers for a specific journey's segment in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkinBySegmentDelete' operationId: nsk_v1_booking_checkin_segment_segmentKey_delete parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/checkin/segment/{segmentKey}: post: tags: - booking/checkin summary: Checks in a collection of passengers to a specific journey's segment in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` - When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages` is set to true. - When debug mode is disabled, warning and error messages will be returned to agents only if the `SystemOptions.HideErrorMessages` is set to false. GraphQL endpoint: checkinBySegmentAddv3' operationId: nsk_v3_booking_checkin_segment_segmentKey_post parameters: - name: segmentKey in: path required: true description: The segment key of the segment to checkin. schema: type: string x-position: 1 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequestv3' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Check-in Successful: description: Example when check-in is successful. value: data: null Checkin Valid with displaying warning message to agents.: description: Example message when check in requirements are met, but there are still travel documents required. This requires Digital API configuration to be set such that warning messages can be returned to agents only when debug is turned off. value: messages: - code: CheckinPassengerWarning type: Warning value: 'AUT TEST Authorization Response Free Text 8501:AU:OK TO BOARD Documents are required for this flight.' status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null Checkin Valid with a masked warning message.: description: Example message when check in requirements are met, but there are still travel documents required. This is what non-agents will see regardless of Digital API configuration for displaying warning messages when debug is off.This is also what an agent would see if the corresponding API configuration is not set to allow warning messages to be shown. value: messages: - code: CheckinPassengerWarning type: Warning value: CheckinPassengerWarning status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Checkin Invalid: description: Example error when check in requirements are not met. The /requirements endpoint should be called before attempting a checkin. value: errors: - id: null code: nsk:Checkin:Invalid message: nsk:Checkin:Invalid type: Validation details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Checkin request is invalid. Please refer to checkin requirements for more details. 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 Seat Missing: description: In this example the optional request parameter `seatsRequired` was set to true. One passenger had a seat assigned and one did not. value: errors: - id: null code: nsk:Checkin:TypeID:1223 message: nsk:Checkin:TypeID:1223 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Baggins/Bilbo missing seat assignments on flight number 2452. 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 Inhibited: description: In this example the passenger meets all the requirements but is inhibited due to government security. value: errors: - id: null code: nsk:Checkin:TypeID:3096 message: nsk:Checkin:TypeID:3096 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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. - id: null code: nsk:Checkin:TypeID:3088 message: nsk:Checkin:TypeID:3088 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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 Missing verified document with agent visible error message: description: This example shows both the expected response when a passenger is missing verified documents, as well as what a logged-in agent would see if the API configuration is set correctly. This is an example response when debug mode is turned off. value: errors: - id: null code: nsk:Checkin:TypeID:1236 message: Baggins/Bilbo missing verified documents. type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ 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 '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/checkin/segment/{segmentKey}/requirements: get: tags: - booking/checkin summary: Gets the checkin pre-validation requirements for a specific journey's segment. description: 'GraphQL endpoint: checkinBySegmentRequirementsv2' operationId: nsk_v2_booking_checkin_segment_segmentKey_requirements_get parameters: - name: segmentKey in: path required: true description: The segment key to pre validate checkin with. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirementsv2' examples: Valid Response No Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: documentsOnFile: - P - V governmentDocumentInstances: - governmentInstance: USDHS numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I - group: 5 documentTypeCode: M verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true - governmentInstance: CBSA numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true isValid: true addressRequirements: isValid: false addressesOnFile: - Address1 unhandledAddresses: - Address2 invalidSsrs: null requiredSsrs: null restrictions: null isValid: true governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 cbsa: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: CBSA messageType: null minVerifiedDocumentCount: 1 restrictions: null isValid: true Response with Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: null addressRequirements: null invalidSsrs: null requiredSsrs: null restrictions: - restriction: 12 description: Missing Documents - restriction: 1 description: Missing Destination Address isValid: false governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 restrictions: - 4 isValid: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/checkin/segment/{segmentKey}/requirements: get: tags: - booking/checkin summary: Gets the checkin pre-validation requirements for a specific journey's segment. description: 'GraphQL endpoint: checkinBySegmentRequirements' operationId: nsk_v1_booking_checkin_segment_segmentKey_requirements_get parameters: - name: segmentKey in: path required: true description: The segment key to pre validate checkin with. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirements' examples: Not Paid In Full: description: Example partial response showing that the payment is due before check in value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 4 Closed: description: Example partial response showing that the check in is closed which is common if its outside of the configured check in window. value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 0 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/checkin/segment/{segmentKey}/status: get: tags: - booking/checkin summary: Gets the passenger lift status for a specific segment based on the booking in state. description: 'GraphQL endpoint: checkinBySegmentStatus' operationId: nsk_v1_booking_checkin_segment_segmentKey_status_get parameters: - name: segmentKey in: path required: true description: The segment key in reference. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/comments: get: tags: - booking summary: Gets the list of comments on the in-state booking. description: Gets the list of comments on the in-state booking. operationId: nsk_v1_booking_comments_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingComment' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/comments/{commentKey}: delete: tags: - booking summary: Deletes a comment from the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingCommentsDeletev2' operationId: nsk_v2_booking_comments_commentKey_delete parameters: - name: commentKey in: path required: true description: The booking comment key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/contacts: get: tags: - booking/contacts summary: Gets all the contacts on the booking. description: Gets all the contacts on the booking. operationId: nsk_v1_booking_contacts_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfCharAndContact' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/contacts summary: Creates a new contact on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` Note: New Skies does not support the Mobile phone number type for booking contacts. GraphQL endpoint: contactsAdd' operationId: nsk_v1_booking_contacts_post requestBody: x-name: request description: The new contact. content: application/json: schema: $ref: '#/components/schemas/Contact' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Created contact: description: A contact was created and added to the booking. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Contact Type Code: description: The contact type code is invalid or not configured in the system. The list of valid contact type codes can be retrieved using the GET api/nsk/v1/resources/ContactTypes endpoint. value: errors: - id: 12bd2c3d-ddd4-5844-3sz5-3cg52c2e13n1 code: nsk:Contact:InvalidContactTypeCode message: The contact type code 'S' is invalid. type: Validation details: contactTypeCode: S rawMessage: The contact type code 'S' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Duplicate Contact Type Code: description: The contact type code already exists in the booking. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Contact:DuplicateTypeCode message: Duplicate contact type 'P' detected. type: Validation details: contactTypeCode: P rawMessage: Duplicate contact type 'P' detected. 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. With No Contact Type Code: description: The contact type code in the request is not populated. value: errors: - id: 5f490eab-3a4d-a783-14ed-25456aecf82f code: Contact.ContactTypeCode:RequiredAttribute message: The Contact field is required. type: Validation details: null rawMessage: The Contact field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Incomplete Booking Contact Info: description: The booking contact info provided is incomplete. value: errors: - id: 666e7592-c107-3812-46e6-f7147dd3c5cd code: nsk-server:BookingContactInfoIncomplete message: Missing or invalid GST Registration Number. type: Validation details: null rawMessage: Missing or invalid GST Registration Number. 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. With No Booking in State: description: No booking was put into state before creating a contact. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: No booking was found in session, cannot perform operation. type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: The contact request field is null value: errors: - id: 292fcb67-e1de-eb62-3d1a-123a586b03a9 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/contacts/{contactTypeCode}: get: tags: - booking/contacts summary: Gets a specific contact on the booking. description: 'GraphQL endpoint: contacts' operationId: nsk_v1_booking_contacts_contactTypeCode_get parameters: - name: contactTypeCode in: path required: true description: The unique contact type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfContact' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/contacts summary: Updates a specific contact on the booking based on type code. description: 'GraphQL endpoint: contactsSet' operationId: nsk_v1_booking_contacts_contactTypeCode_put parameters: - name: contactTypeCode in: path required: true description: The unique type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 requestBody: x-name: request description: The modified contact. content: application/json: schema: $ref: '#/components/schemas/ContactRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/contacts summary: Patches a specific contact on the booking based on type code. description: 'GraphQL endpoint: contactsModify' operationId: nsk_v1_booking_contacts_contactTypeCode_patch parameters: - name: contactTypeCode in: path required: true description: The unique type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 requestBody: x-name: request description: The patched contact request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfContactBase' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/contacts summary: Deletes a specific contact on the booking based on type code. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: contactsDelete' operationId: nsk_v1_booking_contacts_contactTypeCode_delete parameters: - name: contactTypeCode in: path required: true description: The unique type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/contacts/{contactTypeCode}/phoneNumbers: get: tags: - booking/contacts summary: Gets the collection of phone number for a specific contact on the booking. description: Gets the collection of phone number for a specific contact on the booking. operationId: nsk_v1_booking_contacts_contactTypeCode_phoneNumbers_get parameters: - name: contactTypeCode in: path required: true description: The unique contact type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPhoneNumber' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/contacts summary: Creates a new phone number on a specific contact on the booking. description: 'GraphQL endpoint: contactsPhoneAdd' operationId: nsk_v1_booking_contacts_contactTypeCode_phoneNumbers_post parameters: - name: contactTypeCode in: path required: true description: The unique contact type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 requestBody: x-name: request description: The new phone number. content: application/json: schema: $ref: '#/components/schemas/PhoneNumber' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/contacts/{contactTypeCode}/phoneNumbers/{phoneNumberType}: get: tags: - booking/contacts summary: Gets the specific phone number from a specific contact on the booking. description: 'GraphQL endpoint: contactsPhone' operationId: nsk_v1_booking_contacts_contactTypeCode_phoneNumbers_phoneNumberType_get parameters: - name: contactTypeCode in: path required: true description: The unique contact type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: phoneNumberType in: path required: true description: "The phone number type. \nEnumeration values: 0 = Other, 1 =\ \ Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPhoneNumber' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/contacts summary: Updates a specific phone number on a specific contact on the booking. description: 'GraphQL endpoint: contactsPhoneSet' operationId: nsk_v1_booking_contacts_contactTypeCode_phoneNumbers_phoneNumberType_put parameters: - name: contactTypeCode in: path required: true description: The unique contact type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: phoneNumberType in: path required: true description: "The phone number type. \nEnumeration values: 0 = Other, 1 =\ \ Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 requestBody: x-name: request description: The modified phone number. content: application/json: schema: $ref: '#/components/schemas/PhoneNumberBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/contacts summary: Deletes a specific phone number on a specific contact on the booking. description: 'GraphQL endpoint: contactsPhoneDelete' operationId: nsk_v1_booking_contacts_contactTypeCode_phoneNumbers_phoneNumberType_delete parameters: - name: contactTypeCode in: path required: true description: The unique contact type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: phoneNumberType in: path required: true description: "The phone number type. \nEnumeration values: 0 = Other, 1 =\ \ Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/contacts/primary: get: tags: - booking/contacts summary: Gets the primary contact based on configuration. description: 'GraphQL endpoint: primaryContact' operationId: nsk_v1_booking_contacts_primary_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfContact' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/contacts summary: Creates a new primary contact based on configuration. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: primaryContactAdd' operationId: nsk_v1_booking_contacts_primary_post requestBody: x-name: request description: The new contact. content: application/json: schema: $ref: '#/components/schemas/ContactRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/contacts summary: Updates the primary contact. description: 'GraphQL endpoint: primaryContactSet' operationId: nsk_v1_booking_contacts_primary_put requestBody: x-name: request description: The modified contact request. content: application/json: schema: $ref: '#/components/schemas/ContactRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/contacts summary: Patches the primary contact. description: 'GraphQL endpoint: primaryContactModify' operationId: nsk_v1_booking_contacts_primary_patch requestBody: x-name: request description: The patched contact request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfContactBase' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/contacts summary: Delete the primary contact. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: primaryContactDelete' operationId: nsk_v1_booking_contacts_primary_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/divide: post: tags: - booking summary: Divides the current booking. description: 'A valid user must be logged in to divide a booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingDividev2' operationId: nsk_v2_booking_divide_post requestBody: x-name: request description: Contains the divide request information. content: application/json: schema: $ref: '#/components/schemas/DivideRequestv2' required: true x-position: 1 responses: '201': description: Successfully divided. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '200': description: Successfully divided and canceled. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/equipment/legs/{legKey}: get: tags: - booking summary: Retrieves equipment information for a specified leg. description: 'GraphQL endpoint: legEquipmentv2' operationId: nsk_v2_booking_equipment_legs_legKey_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfEquipmentBasev2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/equipment/legs/{legKey}/properties: get: tags: - booking summary: Retrieves equipment, supported seat property and seat-dependent SSR information for a specified leg. description: 'GraphQL endpoint: legEquipmentPropertiesv2' operationId: nsk_v2_booking_equipment_legs_legKey_properties_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfEquipmentv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/equipment/segments/{segmentKey}: get: tags: - booking summary: Retrieves equipment information for all legs on a specified segment. description: 'GraphQL endpoint: segmentEquipmentv2' operationId: nsk_v2_booking_equipment_segments_segmentKey_get parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEquipmentBasev2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/equipment/segments/{segmentKey}/properties: get: tags: - booking summary: 'Retrieves equipment, supported seat property and seat-dependent SSR information for all legs on a specified segment.' description: 'GraphQL endpoint: segmentEquipmentPropertiesv2' operationId: nsk_v2_booking_equipment_segments_segmentKey_properties_get parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEquipmentv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/eTickets: post: tags: - booking summary: BETA - Issues new e-tickets and re-issues existing e-tickets for segments with voluntary changes. description: 'The endpoint performs validation and determines internally if the booking is for issuance of new e-tickets or re-issuance of existing e-tickets. For some cases that the re-issuance is not allowed by the ticketing service, a `502 BadGateway` will be returned and new e-tickets can be issued using the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint. GraphQL endpoint: eTicketAddv2' operationId: nsk_v2_booking_eTickets_post responses: '201': description: Successfully issued or re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '502': description: Bad gateway. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Failure to re-issue and needs new e-tickets: description: Example error when the attempt to re-issue was not allowed by the ticketing service and issuance of new e-tickets is needed instead. value: errors: - id: null code: nsk:ETickets:IssuanceOfNewETicketsRequired message: nsk:ETickets:IssuanceOfNewETicketsRequired type: Error details: null rawMessage: The ticketing service did not allow the re-issuance of e-tickets and new e-tickets are required to be issued instead. Please call the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint to force issuance of new e-tickets. 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 put: tags: - booking summary: BETA - Re-issues existing e-tickets for segments with involuntary changes such as schedule change and IROP. description: 'For some cases that the re-issuance is not allowed by the ticketing service, a `502 BadGateway` will be returned and new e-tickets can be issued using the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint. GraphQL endpoint: eTicketSetv2' operationId: nsk_v2_booking_eTickets_put responses: '200': description: Successfully re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '502': description: Bad gateway. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Failure to re-issue and needs new e-tickets: description: Example error when the attempt to re-issue was not allowed by the ticketing service and issuance of new e-tickets is needed instead. value: errors: - id: null code: nsk:ETickets:IssuanceOfNewETicketsRequired message: nsk:ETickets:IssuanceOfNewETicketsRequired type: Error details: null rawMessage: The ticketing service did not allow the re-issuance of e-tickets and new e-tickets are required to be issued instead. Please call the POST `api/nsk/v1/booking/eTickets/forceIssue` endpoint to force issuance of new e-tickets. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/booking/eTickets: post: tags: - booking summary: Issues new e-tickets and re-issues existing e-tickets for segments with voluntary changes. description: 'The endpoint performs validation and determines internally if the booking is for issuance of new e-tickets or re-issuance of existing e-tickets. For some cases that the re-issuance is not allowed by the ticketing service, new e-tickets are issued instead. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: eTicketAdd' operationId: nsk_v1_booking_eTickets_post responses: '201': description: Successfully issued or re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '502': description: Bad gateway. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking summary: Re-issues existing e-tickets for segments with involuntary changes such as schedule change and IROP. description: 'For some cases that the re-issuance is not allowed by the ticketing service, new e-tickets are issued instead. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: eTicketSet' operationId: nsk_v1_booking_eTickets_put responses: '200': description: Successfully re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '502': description: Bad gateway. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/eTickets/forceIssue: post: tags: - booking summary: BETA - Forces issuance of new e-tickets when re-issuance is not allowed by the ticketing service. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is intended to be used only if the POST or PUT e-tickets endpoints return an error with code `nsk:ETickets:IssuanceOfNewETicketsRequired`. Tickets are accountable documents and need to be available for check-in, refund or exchange. Using this endpoint other than the said use case would potentially cause negative impact during settlement and would require carriers to manually identify and close out e-tickets that were left open. GraphQL endpoint: eTicketForceAdd' operationId: nsk_v1_booking_eTickets_forceIssue_post responses: '201': description: Successfully issued or re-issued e-tickets. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssueETicketResponse' examples: Successfully issue or reissue new e-tickets: description: Example response when issuance or re-issuance of e-tickets is successful. value: ticketNumbers: - 0286010103190 - 0286010103191 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: E-Ticket Required for Force Issuance: description: Example response when an existing e-ticket is required for force issuance. value: errors: - id: null code: nsk:ETickets:ETicketRequiredForForceIssuance message: nsk:ETickets:ETicketRequiredForForceIssuance type: Error details: null rawMessage: An existing e-ticket is required for force issuance of new e-tickets 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 '502': description: Bad gateway. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/eTickets/validation: get: tags: - booking summary: Checks if the booking in state is valid for e-ticketing operations. description: 'GraphQL endpoint: eTicketBookingValidation' operationId: nsk_v1_booking_eTickets_validation_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfETicketBookingValidationResponse' /api/nsk/v1/booking/fareOverride/journey/{journeyKey}: post: tags: - booking summary: Replaces an existing fare price with an amount specified. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: fareOverrideAdd' operationId: nsk_v1_booking_fareOverride_journey_journeyKey_post parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 requestBody: x-name: request description: The fare override request. content: application/json: schema: $ref: '#/components/schemas/FareOverrideRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/fareRules: get: tags: - booking summary: Retrieves the collection of all fare rules from the current booking in state. description: 'Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture sensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the content and the fare rules will be returned as an rtf string. GraphQL endpoint: fareRulesv3' operationId: nsk_v2_booking_fareRules_get parameters: - name: convertToHtml in: query description: Whether to convert to html. Defaults to true. schema: type: boolean nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareRule' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/fareRules/category50/journeys/{journeyKey}/segments/{segmentKey}: post: tags: - booking summary: Get the category 50 fare rule information for a specific segment on a booking. description: 'This is functionally a GET but POST is used to reduce URL length overhead. GraphQL endpoint: bookingCategory50FareRuleInfov3' operationId: nsk_v2_booking_fareRules_category50_journeys_journeyKey_segments_segmentKey_post parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 2 - name: cultureCode in: query description: the culture code. schema: type: string nullable: true x-position: 3 - name: convertToHtml in: query description: If true, converts the response's Text value from RTF to HTML. Defaults to true. schema: type: boolean nullable: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCategory50Responsev2' examples: Retrieve Category 50 Fare Rule Information: description: Example response for successfully retrieving the category 50 fare rule information. value: data: title: Category 50 Fare Rule text: 'Fare Rules and Conditions: Tickets are available for purchase by all individuals aged 18 and above.' dataType: 0 cultureCode: en-US '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Journey Key: description: The journey key is not valid nor does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'journeyKey' with value 'MTW' is invalid. type: Validation details: journeyKey: MTW rawMessage: The identifier 'journeyKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Segment Key: description: The segment key is not valid nor does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'segmentKey' with value 'MTW' is invalid. type: Validation details: segmentKey: MTW rawMessage: The identifier 'segmentKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Null Fare Rule Information: description: Example response when there is no fare rule information returned. value: data: null /api/nsk/v1/booking/fareRules/fare/{fareKey}: get: tags: - booking summary: 'Retrieves a fare rule from the current booking in state based on the specific fare key.' description: 'Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture sensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the content and the fare rules will be returned as an rtf string. GraphQL endpoint: fareRulesByKeyv2' operationId: nsk_v1_booking_fareRules_fare_fareKey_get parameters: - name: fareKey in: path required: true description: The unique fare key. schema: type: string x-position: 1 - name: convertToHtml in: query description: Whether to convert to html. Defaults to true. schema: type: boolean nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFareRule' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/fareRules/journey/{journeyKey}: get: tags: - booking summary: 'Retrieves the collection of all fare rules from the current booking in state for the specific journey key.' description: 'Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture sensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the content and the fare rules will be returned as an rtf string. GraphQL endpoint: fareRulesByJourneyv3' operationId: nsk_v2_booking_fareRules_journey_journeyKey_get parameters: - name: journeyKey in: path required: true description: The unique journey key. schema: type: string x-position: 1 - name: convertToHtml in: query description: Whether to convert to html. Defaults to true. schema: type: boolean nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareRule' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/fareRules/segment/{segmentKey}: get: tags: - booking summary: Retrieves the collection of all fare rules from the current booking in state for the specific segment key. description: 'Note that this defaults to returning the fare rules in html format. The html format may not be entirely culture sensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the content and the fare rules will be returned as an rtf string. GraphQL endpoint: fareRulesBySegmentv3' operationId: nsk_v2_booking_fareRules_segment_segmentKey_get parameters: - name: segmentKey in: path required: true description: The unique segment key. schema: type: string x-position: 1 - name: convertToHtml in: query description: Whether to convert to html. Defaults to true. schema: type: boolean nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareRule' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/fee: get: tags: - booking summary: Gets the fee price. description: 'Only service and penalty fee types support a price that is configured by the booking in state. Depending on the configuration, the passenger key will be needed. For other fee types the price amount is manually provided. GraphQL endpoint: fee' operationId: nsk_v1_booking_fee_get parameters: - name: PassengerKey in: query description: "The passenger key.\n " schema: type: string nullable: true x-position: 1 - name: Origin in: query description: "The origin station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 2 - name: CollectedCurrencyCode in: query description: "The collected currency code.\n " schema: type: string maxLength: 3 minLength: 1 nullable: true x-position: 3 - name: FeeCode in: query description: "The fee code.\n " schema: type: string maxLength: 6 minLength: 0 nullable: true x-position: 4 - name: FeePricingMode in: query description: "Determines if fees are to be paid in points or with currency.\n\ \ \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" schema: nullable: true $ref: '#/components/schemas/FeePricingMode' x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfServiceCharge' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking summary: Manually adds a new fee. description: 'Penalty fees, spoilage fees, and service fees can be created manually. Other types are automatically created by the system. Depending on the configuration, the passenger key will be needed. If a passenger key was added to the request, the API will attempt to provide a location header url to point to the newly created fee using the passenger key and the passenger fee key from the new fee. However, depending on the fee type, this url may not always be valid. Spoilage fees for example are applied to the primary passenger, so if a non-primary passenger key was added on the request, the resulting url constructed by the API may result in a 404 - Not Found response. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: feeAdd' operationId: nsk_v1_booking_fee_post requestBody: x-name: request description: The fee request. content: application/json: schema: $ref: '#/components/schemas/CommitPassengerFeeRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/fee/{feeKey}: put: tags: - booking summary: Overrides a fee amount. description: 'When the fee override amount is zero, New Skies keeps or removes passenger fees with respect to the Store Confirming Waived Fees system setting. This endpoint returns a HTTP 200 on either case. Please retrieve the state booking afterwards to verify the absence or presence of the overridden fee. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: feeSet' operationId: nsk_v1_booking_fee_feeKey_put parameters: - name: feeKey in: path required: true description: The fee key. schema: type: string x-position: 1 requestBody: x-name: request description: The fee request. content: application/json: schema: $ref: '#/components/schemas/FeeRequestBase' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking summary: Deletes a fee. description: 'If a fee is deleted during the same commit in which it was added, then the fee will not be present on the booking -- It is truly deleted If a fee is waived after it has been committed to a booking, then the fee will still be present, along with a "FEE OR" fee indicating the override is 0. This behavior can be changed by checking the "Store Confirming Waived Fees" box in the Booking Settings dialog in utilities (SYS Users Only). If this box is checked, then all fees will behave in the second manner shown above -- meaning that an uncommitted fee that is overriden to 0 will not be removed from the booking. Additionally, if the fee was added pre-commit and the SkySpeed setting ''Allow Fees to be Deleted'' is enabled for that user, then they will be able to delete the fee without needing waive fee permissions. Post-commit we still require waive fee permissions to override a fee. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: feeDelete' operationId: nsk_v1_booking_fee_feeKey_delete parameters: - name: feeKey in: path required: true description: The fee key request. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/fees: put: tags: - booking summary: Overrides multiple fee amounts. description: 'When the fee override amount is zero, New Skies keeps or removes passenger fees with respect to the Store Confirming Waived Fees system setting. This endpoint returns a HTTP 200 on either case. Please retrieve the state booking afterwards to verify the absence or presence of the overridden fees. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: feeSetMultiple' operationId: nsk_v1_booking_fees_put requestBody: x-name: request description: The multiple fee override request. content: application/json: schema: $ref: '#/components/schemas/MultipleFeeOverrideRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/fees/{feeKey}/quote: get: tags: - booking summary: Gets the override fee quote of an existing fee. description: 'GraphQL endpoint: overrideExistingFeeQuote' operationId: nsk_v1_booking_fees_feeKey_quote_get parameters: - name: feeKey in: path required: true description: The fee key of an existing fee. schema: type: string x-position: 1 - name: Amount in: query description: "The override amount.\n " schema: type: number format: decimal nullable: true x-position: 2 - name: CollectedCurrencyCode in: query description: "The collected currency code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGetOverrideFeeQuoteResponse' examples: Retrieve Override Fee Quote Response: description: Example response for successfully retrieving the override fee quote response. value: data: feeOverrideCharges: - amount: 100.0 code: NFSF detail: Non Flight type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 100.0 ticketCode: NSF '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: Example Error if there is no booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Passenger Key: description: Example Error if passenger key is invalid. value: errors: - id: 2987bed7-5690-5050-55e9-819b8551b344 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'PassengerKey' with value 'MCFBASDFRFQ-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Currency Code: description: Example Error if the currency code is invalid. value: errors: - id: 10daf3f4-82c2-cf99-21ba-169fadae0b10 code: nsk:Validation:UnknownSellCurrencyCode message: nsk:Validation:UnknownSellCurrencyCode type: Validation details: currencyCode: SDK rawMessage: The currency code SDK does not exist or is not active. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Fee Key: description: Example Error if fee key is invalid. value: errors: - id: ea9e908c-8979-85d8-c9ed-886014d6fc46 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'FeeKey' with value 'MT21XF' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Fee Code: description: Example Error if the fee code is not allowed to be quoted. value: errors: - id: bf7c1a48-a4bf-ddf7-2413-93959ba6a3b3 code: nsk-server:FeeCalculation message: nsk-server:FeeCalculation type: Validation details: null rawMessage: Cannot quote overrides of type NameChangeFee for new fees. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Null Fee Code: description: Example Error if the fee code is null value: errors: - id: 6b34775e-d264-f3a6-4034-62daf6699617 code: GetNewOverrideFeeQuoteRequestBase.FeeCode:RequiredAttribute message: The GetNewOverrideFeeQuoteRequestBase field is required. type: Validation details: validation: RequiredAttribute model: GetNewOverrideFeeQuoteRequestBase member: FeeCode rawMessage: The GetNewOverrideFeeQuoteRequestBase field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Null Fee Amount: description: Example Error if the fee amount is null value: errors: - id: 6b34775e-d264-f3a6-4034-62daf6699617 code: GetNewOverrideFeeQuoteRequestBase.FeeCode:RequiredAttribute message: The GetNewOverrideFeeQuoteRequestBase field is required. type: Validation details: validation: RequiredAttribute model: GetNewOverrideFeeQuoteRequestBase member: Amount rawMessage: The GetNewOverrideFeeQuoteRequestBase field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Allow Negative Fees Role Setting Off: description: Example Error if the fee amount is negative or the fee type is not allowed to override, and the role setting is turned off. value: errors: - id: a49a0074-9b6d-9e30-83c3-1c21a56d748c code: nsk:Validation:RoleSettingsProhibit message: nsk:Validation:RoleSettingsProhibit type: Validation details: null rawMessage: Role settings prohibit a negative fee. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Inactive Fees: description: Example Error if the agent attempted to sell inactive fees. value: errors: - id: bee189bc-edfc-263b-edc1-33cbf8b709cf code: nsk:Fee:NotFound message: nsk:Fee:NotFound type: Validation details: null rawMessage: The fee was not found. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Unauthorized Overriding of Service Fees: description: Example Error if the agent is not authorized to override a service fee. value: errors: - id: 7911302f-46af-3dc8-5714-b2823fec853d code: nsk-server:AuthorizationSSRNotAllowed message: Agent is not authorized to override fees. type: Validation details: message: Agent is not authorized to override fees. rawMessage: Agent is not authorized to override fees. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Unauthorized Selling of Service Fees: description: Example Error if the agent is not authorized to sell a service fee. value: errors: - id: cfdacd38-5e2c-ab09-9fce-86722e945f0b code: nsk-server:AuthorizationServiceFeeNotAllowed message: Agent is not authorized to sell service fee FLO. type: Validation details: message: Agent is not authorized to sell service fee FLO. rawMessage: Agent is not authorized to sell service fee FLO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/fees/penalty: delete: tags: - booking summary: Waives the penalty fee of all journeys in the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingPenaltyFeeDelete' operationId: nsk_v1_booking_fees_penalty_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/fees/spoilage: delete: tags: - booking summary: Waives the spoilage fee of all journeys in the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingSpoilageFeeDelete' operationId: nsk_v1_booking_fees_spoilage_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/groupName: put: tags: - booking summary: Changes the group name of the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: groupNameSet' operationId: nsk_v1_booking_groupName_put parameters: - name: groupName in: query description: The booking group name. schema: type: string nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true delete: tags: - booking summary: Deletes the group name of the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: groupNameDelete' operationId: nsk_v1_booking_groupName_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/groupName: put: tags: - booking summary: Changes the group name of the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: groupNameSetv2' operationId: nsk_v2_booking_groupName_put requestBody: x-name: request description: The booking group name request. content: application/json: schema: $ref: '#/components/schemas/BookingGroupNameRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/history: get: tags: - booking/history summary: Gets the current booking history in state. description: 'GraphQL endpoint: bookingHistory' operationId: nsk_v1_booking_history_get parameters: - name: Event in: query description: "The event that triggered the history entry.\n \n\ Enumeration values: 0 = Unknown, 1 = ConvertedHistory, 2 = FlightTimeChange,\ \ 3 = FlightDesignatorChange, 4 = AssignedSeat, 5 = RemoveSeat, 6 = AddedFlight,\ \ 7 = DeletedFlight, 8 = DeletedPassenger, 9 = NameChange, 10 = GroupNameChange,\ \ 11 = CancelledTicketing, 12 = ScheduleChange, 13 = AddedPayment, 14 =\ \ ServiceFee, 15 = QueuedPnr, 16 = UnqueuedPnr, 17 = DeletedComment, 18\ \ = Divided, 19 = CheckedIn, 20 = CheckedOut, 21 = FareOverride, 22 = AddedBaggage,\ \ 23 = ChangedBaggageWeight, 24 = CheckedBaggage, 25 = RemovedBaggage, 26\ \ = BoardedPassenger, 27 = UnboardedPassenger, 28 = ManualAuthorization,\ \ 29 = ManualDecline, 30 = UndoCancel, 31 = ItinerarySent, 32 = ContactChange,\ \ 33 = SsrAdded, 34 = FlightMoved, 35 = VerifiedDocument, 36 = RemovedVerifiedDocument,\ \ 37 = Promotion, 38 = BookingComment, 39 = CancelledSchedule, 40 = CancelServiceFee,\ \ 41 = OverrideServiceFee, 42 = AddedRecordLocator, 43 = DeletedRecordLocator,\ \ 44 = UpgradeClassOfService, 45 = DowngradeClassOfService, 46 = StandbyPriorityChange,\ \ 47 = AssignedTicketNumber, 48 = DeletedTicketNumber, 49 = ConfirmSegmentStatusCodeChange,\ \ 50 = CodeshareFlightChanged, 51 = PdsCancel, 52 = PdsPending, 53 = PdsConfirm,\ \ 54 = PdsFinalized, 55 = PdsDeclined, 56 = PdsException, 57 = PdsCancelRefused,\ \ 58 = PdsCancelUnsuccessful, 59 = Apps, 60 = InhibitedOverride, 61 = PrintedBagTag,\ \ 62 = SelfPrintedBagTag, 63 = PrintedBoardingPass, 64 = AddCustomerId,\ \ 65 = DeleteCustomerId, 66 = HoldCreated, 67 = HoldRemoved, 68 = HoldChanged,\ \ 69 = OverrideCoupon, 70 = PdsSynchronized, 71 = PdsItemremoved, 72 = Reprice,\ \ 73 = ChannelOverride, 74 = EmdCreated, 75 = EmdRemoved, 76 = EmdChanged,\ \ 77 = ServiceBundle, 78 = PublishedFareOverride, 79 = FareClassRealignment,\ \ 80 = AddedDocument, 81 = ChangedDocument, 82 = DeletedPaymentProperties" schema: nullable: true $ref: '#/components/schemas/BookingHistoryEvent' x-position: 1 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 2 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfHistoryResponse' examples: Retrieve Booking History Response: description: Example response for successfully retrieving the booking history. value: data: histories: - historyCategory: 30 details: AD P 1234 event: 2 pointOfSale: isoCountryCode: null sourceSystemCode: null agentCode: CCAuserM domainCode: DEF locationCode: HDQ organizationCode: SYSTEM sourcePointOfSale: isoCountryCode: null sourceSystemCode: null agentCode: CCAuserM domainCode: DEF locationCode: HDQ organizationCode: SYSTEM receivedBy: Dailey, Paltry receivedByReference: 801-555-9965 createdDate: '2026-07-09T05:55:13.8587699+00:00' pageKey: null With Invalid Event Type: description: Example response if event enum is invalid. value: messages: - rawValue: The value '83' is invalid. code: core:Validation:MalformedRequest debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Information value: core:Validation:MalformedRequest status: 0 details: null data: histories: - historyCategory: 30 details: AD P 1234 event: 2 pointOfSale: isoCountryCode: null sourceSystemCode: null agentCode: CCAuserM domainCode: DEF locationCode: HDQ organizationCode: SYSTEM sourcePointOfSale: isoCountryCode: null sourceSystemCode: null agentCode: CCAuserM domainCode: DEF locationCode: HDQ organizationCode: SYSTEM receivedBy: Dailey, Paltry receivedByReference: 801-555-9965 createdDate: '2026-07-09T05:55:13.8588008+00:00' pageKey: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Committed Booking: description: Example error response if there is no committed booking. value: errors: - id: eb0e3db1-a704-6c9b-d89b-bfd4d662af74 code: nsk:Booking:CommittedStateRequired message: nsk:Booking:CommittedStateRequired type: Validation details: null rawMessage: Invalid state. The booking should be committed before this operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '401': description: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/history/bagTagPrint: get: tags: - booking/history summary: Gets the current bag tag print history for the booking in state. description: 'GraphQL endpoint: bookingBagTagPrintHistoryv2' operationId: nsk_v1_booking_history_bagTagPrint_get parameters: - name: isBagTagSelfPrinted in: query description: Whether the bag tag is self printed. schema: type: boolean nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBagTagPrintHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/history summary: Creates a bag tag print history for the booking in state. description: 'Also updates bag''s status from Added to AddedPrinted if Self-Tagging Baggage is enabled. In order to see the status of a bag, check bags on a passenger segment. GraphQL endpoints: bookingBagTagPrintHistoryAdd, bookingBagTagPrintHistoryAddBatch' operationId: nsk_v1_booking_history_bagTagPrint_post requestBody: x-name: request description: The bag tag print history request. content: application/json: schema: $ref: '#/components/schemas/BagTagPrintHistoryRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/history/flightMove: get: tags: - booking/history summary: Gets the current flight move history in state. description: 'GraphQL endpoint: bookingFlightMoveHistory' operationId: nsk_v1_booking_history_flightMove_get parameters: - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 1 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFlightMoveHistoryResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/history/holdDateChange: get: tags: - booking/history summary: Gets the current hold date change history for the booking in state. description: 'GraphQL endpoint: bookingHoldDateChangeHistory' operationId: nsk_v1_booking_history_holdDateChange_get parameters: - name: Event in: query description: "The event that triggered the hold date change history entry.\n\ \ \nEnumeration values: 66 = Created, 67 = Removed, 68 = Changed" schema: nullable: true $ref: '#/components/schemas/HoldDateChangeEvent' x-position: 1 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 2 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfHoldDateChangeHistoryResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/history/itinerarySent: get: tags: - booking/history summary: Gets the current itinerary sent history for the booking in state. description: 'GraphQL endpoint: bookingItinerarySentHistory' operationId: nsk_v1_booking_history_itinerarySent_get parameters: - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 1 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfItinerarySentHistoryResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/history/message: get: tags: - booking/history summary: Gets the current message history in state. description: 'GraphQL endpoint: bookingMessageHistory' operationId: nsk_v1_booking_history_message_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingMessageHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/history/notification: get: tags: - booking/history summary: Gets the current notification history in state. description: 'GraphQL endpoint: bookingNotificationHistory' operationId: nsk_v1_booking_history_notification_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingNotificationHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/history/seatAssignment: get: tags: - booking/history summary: Gets the current seat assignment history in state. description: 'GraphQL endpoint: bookingSeatAssignmentHistory' operationId: nsk_v1_booking_history_seatAssignment_get parameters: - name: Event in: query description: "The event that triggered the seat assignment history entry.\n\ \ \nEnumeration values: 4 = AssignedSeat, 5 = RemoveSeat" schema: nullable: true $ref: '#/components/schemas/SeatAssignmentEvent' x-position: 1 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 2 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSeatAssignmentHistoryResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/history/segmentChange: get: tags: - booking/history summary: Gets the current segment change history in state. description: 'GraphQL endpoint: bookingSegmentChangeHistory' operationId: nsk_v1_booking_history_segmentChange_get parameters: - name: Event in: query description: "The event that triggered the seat assignment history entry.\n\ \ \nEnumeration values: 6 = AddedFlight, 7 = DeletedFlight" schema: nullable: true $ref: '#/components/schemas/SegmentChangeEvent' x-position: 1 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 2 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSegmentChangeHistoryResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/hold/available: get: tags: - booking summary: Retrieves the recommended hold date if hold is available. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingHoldv2' operationId: nsk_v2_booking_hold_available_get responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNullableDateTime' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/indiaGstRegistrationRequirement: get: tags: - booking summary: Returns true if it is expected to prompt the user for India GST registration details. description: 'GraphQL endpoint: indiaGstRegistrationRequirement' operationId: nsk_v1_booking_indiaGstRegistrationRequirement_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoolean' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/info: get: tags: - booking summary: Gets the details of the current booking in state. description: 'This endpoint returns the same booking information in the GET /api/nsk/v1/booking endpoint, but with the addition of the eligibility of the booking for external baggage display. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingInfo' operationId: nsk_v1_booking_info_get responses: '200': description: OK. The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingInfov2' examples: Retrieve booking information: description: Successful retrieval of the booking information value: data: isBookingEligibleForExternalBaggageDisplay: true status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: L channelType: 1 bookedDate: '2026-07-09T05:55:13.0532675Z' createdDate: '2026-07-09T05:55:13.0532678Z' expirationDate: '2026-07-12T05:55:13.053268Z' modifiedDate: '2026-07-09T05:58:13.0532694Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No booking in state: description: There is no booking to retrieve in the session state. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/itinerary/print: post: tags: - booking summary: 'Sends the booking itinerary notification to the specified printer. Automatically commits uncommitted changes to the state booking before queuing the booking to a print notification queue.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingItineraryPrint' operationId: nsk_v1_booking_itinerary_print_post requestBody: x-name: request description: The print itinerary request. content: application/json: schema: $ref: '#/components/schemas/PrintItineraryRequest' required: true x-position: 1 responses: '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys: get: tags: - booking/journeys summary: Gets the collection of journeys on the booking in state. description: 'GraphQL endpoint: journeys' operationId: nsk_v1_booking_journeys_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfJourney' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/journeys summary: Cancels all the journeys on the current booking in state. description: 'This endpoint also cancels all booking components/add-ons. To only cancel journeys, use DELETE /api/nsk/v1/booking/journeys/{journeyKey}. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: journeyDeleteAll' operationId: nsk_v1_booking_journeys_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}: get: tags: - booking/journeys summary: Gets a single journey by the key. description: 'GraphQL endpoint: journey' operationId: nsk_v1_booking_journeys_journeyKey_get parameters: - name: journeyKey in: path required: true description: The journey key to be retrieved. schema: type: string x-position: 1 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfJourney' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/journeys summary: Cancels the specific journey from the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: journeyDelete' operationId: nsk_v1_booking_journeys_journeyKey_delete parameters: - name: journeyKey in: path required: true description: The journey key to be canceled. schema: type: string x-position: 1 requestBody: x-name: request description: The cancel journey request options. content: application/json: schema: $ref: '#/components/schemas/CancelJourneyRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/bundles: delete: tags: - booking/journeys summary: Removes the add-on service bundles of the requested passengers in the given journey. description: 'This endpoint does not support removal of included bundles. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bundleDelete' operationId: nsk_v1_booking_journeys_journeyKey_bundles_delete parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 requestBody: x-name: passengersKeys description: The passengers to remove bundles from. content: application/json: schema: type: array items: type: string required: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/journeys/{journeyKey}/bundles: post: tags: - booking/journeys summary: Sells a service bundle for one or more passengers on a journey. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bundleSellv2' operationId: nsk_v2_booking_journeys_journeyKey_bundles_post parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 requestBody: x-name: request description: The bundle sell request. content: application/json: schema: $ref: '#/components/schemas/BundleSellRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Already Booked SSR or Bundle: description: Example OSI Message if passenger already booked an SSR or bundle value: messages: - rawValue: '[HMC] cannot be sold because passenger 0 already booked [THCS] on NV3075 YTZ-LAX.' code: CannotSellBundleSSR debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: CannotSellBundleSSR status: 0 details: cannotSellBundleSSRMessage: '[HMC] cannot be sold because passenger 0 already booked [THCS] on NV3075 YTZ-LAX.' data: null With Cannot Find Interchangeable Bundle SSR: description: Example OSI Message if cannot find interchangeable bundle SSR in state value: messages: - rawValue: Cannot find interchangeable bundle SSR for [HMC] in state. code: CannotSellBundleSSR debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: CannotSellBundleSSR status: 0 details: cannotSellBundleSSRMessage: Cannot find interchangeable bundle SSR for [HMC] in state. data: null With SSR Not Found in Service Bundle: description: Example OSI Message if an SSR is not found in service bundle value: messages: - rawValue: SSR [HMC] not found in service bundle. code: CannotSellBundleSSR debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: CannotSellBundleSSR status: 0 details: cannotSellBundleSSRMessage: SSR [HMC] not found in service bundle. data: null With Duplicate SSR or Bundle: description: Example OSI Message if duplicate SSR or Bundle value: messages: - rawValue: Duplicate SSR [THCS] in SAN-YTZ is not allowed for service bundle. code: CannotSellBundleSSR debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: CannotSellBundleSSR status: 0 details: cannotSellBundleSSRMessage: Duplicate SSR [THCS] in SAN-YTZ is not allowed for service bundle. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/fees/penalty: delete: tags: - booking/journeys summary: Waives the penalty fee of the specified journey. description: 'Waiving the penalty fee is configurable. See the "Fee and Tax Settings", "Single Penalty Fee" option. If this is checked and configured this endpoint will waive the penalty fees from all journeys in the booking in state. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: journeyPenaltyFeeDelete' operationId: nsk_v1_booking_journeys_journeyKey_fees_penalty_delete parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/address/requirements: get: tags: - booking/journeys summary: 'Gets the passenger or associated infant''s destination address requirements for a specific journey for the booking in-state.' description: 'This endpoint will determine if the passenger or the associated infant requires a destination address for the given journey. This does not determine if the passenger already has a qualifying address, only if the destination address is required. GraphQL endpoint: destinationAddressRequirementsByKey' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_address_requirements_get parameters: - name: journeyKey in: path required: true description: The journey key to check requirements for. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key to check requirements for. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoolean' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage: get: tags: - booking/journeys summary: Gets all baggage for a passenger on a specific journey. description: 'GraphQL endpoint: passengerBagJourneys' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_baggage_get parameters: - name: journeyKey in: path required: true description: The journey key for the journey to retrieve from. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key for the passenger to retrieve from. schema: type: string x-position: 2 responses: '200': description: OK. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerBag' '404': description: Baggage was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/journeys summary: Adds baggage to the booking. description: 'This call must be followed by a commit to see the bags added in state. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerBagAdd' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_baggage_post parameters: - name: journeyKey in: path required: true description: The unique identifier for the journey to add to. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The specific passenger key. schema: type: string x-position: 2 requestBody: x-name: request description: A request to add bags to the given passenger. content: application/json: schema: $ref: '#/components/schemas/PassengerBagRequest' required: true x-position: 3 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/{baggageKey}: get: tags: - booking/journeys summary: Gets a single bag from a passenger on a journey. description: 'GraphQL endpoint: passengerBagJourney' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_baggage_baggageKey_get parameters: - name: journeyKey in: path required: true description: The journey key for the journey to retrieve from. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key for the passenger to retrieve from. schema: type: string x-position: 2 - name: baggageKey in: path required: true description: The bag key for the bag to retrieve. schema: type: string x-position: 3 responses: '200': description: OK. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerBag' '404': description: Bag was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/journeys summary: Checks-in the baggage for a passenger on the booking in state. description: 'This is to be called after a stateful adding of baggage to a booking and a commit must follow the completion of this in order to see the bag checked in. Also, this call properly syncs with baggage allowances and usages once completed. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerBagCheckIn' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_baggage_baggageKey_put parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 - name: baggageKey in: path required: true description: The baggage key. schema: type: string x-position: 3 requestBody: x-name: request description: The baggage check-in request. content: application/json: schema: $ref: '#/components/schemas/PassengerBagCheckInRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true delete: tags: - booking/journeys summary: Removes baggage from the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerBagDelete' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_baggage_baggageKey_delete parameters: - name: journeyKey in: path required: true description: The unique identifier for the journey to remove from. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The specific passenger key. schema: type: string x-position: 2 - name: baggageKey in: path required: true description: Unique identifier for the bag to remove. schema: type: string x-position: 3 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/{baggageKey}: put: tags: - booking/journeys summary: Updates the baggage for a passenger on the booking in state. description: 'This is to be called after a stateful adding of baggage to a booking and a commit must follow the completion of this in order to see the bag checked in. This call does NOT sync with baggage allowances and usages. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerBagSet' operationId: nsk_v2_booking_journeys_journeyKey_passengers_passengerKey_baggage_baggageKey_put parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 - name: baggageKey in: path required: true description: The baggage key. schema: type: string x-position: 3 requestBody: x-name: request description: The baggage update request. content: application/json: schema: $ref: '#/components/schemas/PassengerBagUpdateRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Baggage Key: description: Example Error if baggage key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: baggageKey: MDAyODAzMDg0MQ-- rawMessage: The identifier 'BaggageKey' with value 'MDAyODAzMDg0MQ--' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Update Failed Exception: description: Example error if the update failed. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object PassengerBagUpdateRequest has failed. Please verify this object exists. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/{baggageKey}/checkin: put: tags: - booking/journeys summary: Checks in the baggage for a passenger on the booking in state. description: 'This is to be called after a stateful adding of baggage to a booking and a commit must follow the completion of this in order to see the bag checked in. Also, this call properly syncs with baggage allowances and usages once completed. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerBagCheckIn' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_baggage_baggageKey_checkin_put parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 - name: baggageKey in: path required: true description: The baggage key. schema: type: string x-position: 3 requestBody: x-name: request description: The baggage check-in request. content: application/json: schema: $ref: '#/components/schemas/PassengerBagCheckInRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Baggage Key: description: Example Error if baggage key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: baggageKey: MDAyODAzMDg0MQ-- rawMessage: The identifier 'BaggageKey' with value 'MDAyODAzMDg0MQ--' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Baggage Checkin Failed: description: If baggage check-in failed. value: errors: - id: null code: nsk:Baggage:BaggageCheckinFailed message: nsk:Baggage:BaggageCheckinFailed type: Error details: null rawMessage: The baggage check-in for the booking in state failed. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/group: put: tags: - booking/journeys summary: Moves passenger to a different baggage group. description: 'Passengers in the same baggage group may share baggage allowances, enabling baggage allowance pooling. `PassengerBagGroupRequest.BaggageGroupNumber` only accepts bag group numbers from existing passenger bag group numbers. Passenger bag group number is exposed under passenger segment. If set to null, the passenger will be moved to a new bag group. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoints: passengerBagGroupSet, passengerBagGroupSetBatch' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_baggage_group_put parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 requestBody: x-name: request description: The passenger bag group request. content: application/json: schema: $ref: '#/components/schemas/PassengerBagGroupRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/manual: post: tags: - booking/journeys summary: Adds manually tagged baggage to the booking. description: 'This call must be followed by a commit to see the bags added in state. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerManualBagAdd' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_baggage_manual_post parameters: - name: journeyKey in: path required: true description: The unique identifier for the journey to add to. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The specific passenger key. schema: type: string x-position: 2 requestBody: x-name: request description: A request to add manually tagged bags to the given passenger. content: application/json: schema: $ref: '#/components/schemas/PassengerManualBagRequest' required: true x-position: 3 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/fees/amount: delete: tags: - booking/journeys summary: 'Waives fees for a specific journey and passenger, based upon the given fee type. This is an agent-only endpoint.' description: 'NOTE: This endpoint takes a singular property for the request body and as such the request will need to be formatted differently than what it typically looks like. For more information, please see https://navitaire-developer-digital-api.azurewebsites.net/articles/Miscellaneous/UniqueInputSingleRequestBodiesREST. and the Swagger request examples. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerFeesAmountDelete' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_fees_amount_delete parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 2 requestBody: x-name: waiveFeeType description: The waive fee type. content: application/json: schema: type: string examples: Waiving a fee of type Spoilage Fee JSON request body, 1: description: Example request for when wanting to have a waive fee type of `SpoilageFee`. value: 2 Waiving a fee of type Spoilage Fee JSON request body, 2: description: Example request for when wanting to have a waive fee type of `SpoilageFee`. value: SpoilageFee x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/infant: post: tags: - booking/journeys summary: Creates an infant on a passenger in the specified journey. description: 'If the booking in state contains a passive segment, an infant will not be created on the passive segment for the passenger. If one of the segments in the journey already has an infant, the infant details from the request will be ignored and the infant details from the existing infant will be retained. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerInfantJourneyAdd' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_infant_post parameters: - name: journeyKey in: path required: true description: The unique journey key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 2 requestBody: x-name: request description: The new infant. content: application/json: schema: $ref: '#/components/schemas/PassengerInfantCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/journeys summary: Deletes an infant from a passenger in the specified journey. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantJourneyDelete' operationId: nsk_v1_booking_journeys_journeyKey_passengers_passengerKey_infant_delete parameters: - name: journeyKey in: path required: true description: The unique identifier of the journey to remove infants from. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/segments/{segmentKey}/status: patch: tags: - booking/journeys summary: Modifies the status of the specified segment in the journey. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: segmentStatusModify' operationId: nsk_v1_booking_journeys_journeyKey_segments_segmentKey_status_patch parameters: - name: journeyKey in: path required: true description: The journey that contains the specified segment. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment to be modified. schema: type: string x-position: 2 - name: newStatus in: query description: "The new segment status to be set. \nEnumeration values: 0 =\ \ UnknownStatus, 1 = NoActionTaken, 2 = UnableToConfirmSegment, 3 = HeldConfirmed,\ \ 4 = HeldCancelled, 5 = ConfirmedTimeChange" schema: nullable: true $ref: '#/components/schemas/ModifySegmentStatus' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/{journeyKey}/travelDocument/requirements: get: tags: - booking/journeys summary: Gets the travel document requirements for a specific journey for the booking in-state. description: 'This endpoint will return a response containing a collection of travel document type codes that could fulfill a travel document requirement. If the "AtLeastOneDocumentRequired" value is true, then one or more documents in the list are required. However, it does not mean that every document in the list is required. If "AtLeastOneDocumentRequired" is false, then the list of document type codes represents a list of acceptable travel documents, but nothing is required. This endpoint does not determine if any passengers already have required travel documents. GraphQL endpoint: travelDocumentRequirementsByKey' operationId: nsk_v1_booking_journeys_journeyKey_travelDocument_requirements_get parameters: - name: journeyKey in: path required: true description: The journey key to get required travel documents for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTravelDocumentRequirements' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/passengers/{passengerKey}/address/requirements: get: tags: - booking/journeys summary: 'Gets the passenger or associated infant''s destination address requirements for all journeys for the booking in-state.' description: 'This endpoint will determine if the passenger or the associated infant requires a destination address. If a destination address is required for the passenger or associated infant for any journey, then this will return true. This does not determine if the passenger already has a qualifying address, only if the destination address is required. GraphQL endpoint: destinationAddressRequirements' operationId: nsk_v1_booking_journeys_passengers_passengerKey_address_requirements_get parameters: - name: passengerKey in: path required: true description: The passenger key to check requirements for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBoolean' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/journeys/travelDocument/requirements: get: tags: - booking/journeys summary: Gets the travel document requirements for all journeys for the booking in-state. description: 'This endpoint will return a response containing a collection of travel document type codes that could fulfill a travel document requirement. If the "AtLeastOneDocumentRequired" value is true, then one or more documents in the list are required. However, it does not mean that every document in the list is required. If "AtLeastOneDocumentRequired" is false, then the list of document type codes represents a list of acceptable travel documents, but nothing is required. This endpoint does not determine if any passengers already have required travel documents. GraphQL endpoint: travelDocumentRequirements' operationId: nsk_v1_booking_journeys_travelDocument_requirements_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTravelDocumentRequirements' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers: get: tags: - booking/passengers summary: Gets the collection of passengers on the booking. description: 'GraphQL endpoint: passengers' operationId: nsk_v1_booking_passengers_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPassenger' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications: get: tags: - booking/passengers summary: Gets passenger travel notifications for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotifications' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTravelNotification' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Creates a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotificationsAdd' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_post parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 requestBody: x-name: request description: The passenger travel notification create request. content: application/json: schema: $ref: '#/components/schemas/TravelNotificationCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}: get: tags: - booking/passengers summary: Gets a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotification' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTravelNotification' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/passengers summary: Updates a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotificationsSet' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_put parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The travel notification edit request. content: application/json: schema: $ref: '#/components/schemas/TravelNotificationEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotificationsModify' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_patch parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The delta mapper travel notification edit request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelNotificationEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a passenger travel notification for a specific passenger on the booking in state. description: 'GraphQL endpoint: passengerTravelNotificationsDelete' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_delete parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}/events: get: tags: - booking/passengers summary: Gets notification events for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationEvents' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_events_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Adds a notification event to a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationEventsAdd' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_events_post parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The notification event create request. content: application/json: schema: $ref: '#/components/schemas/NotificationEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}/events/{eventType}: get: tags: - booking/passengers summary: Get a notification event for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationEvent' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_events_eventType_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: eventType in: path required: true description: "The event type. \nEnumeration values: 0 = DepartureDelay, 1\ \ = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" schema: $ref: '#/components/schemas/NotificationEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNotificationEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a notification event from a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationEventsDelete' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_events_eventType_delete parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: eventType in: path required: true description: "The notification event type. \nEnumeration values: 0 = DepartureDelay,\ \ 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" schema: $ref: '#/components/schemas/NotificationEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}/timedEvents: get: tags: - booking/passengers summary: Gets notification timed events for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEvents' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationTimedEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Adds a notification timed event to a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEventsAdd' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_post parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The notification timed even create request. content: application/json: schema: $ref: '#/components/schemas/NotificationTimedEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' ? /api/nsk/v1/booking/passengers/{passengerAlternateKey}/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType} : get: tags: - booking/passengers summary: Get a notification timed event for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEvent' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_get parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The timed event type. \nEnumeration values: 0 = Departure, 1\ \ = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNotificationTimedEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/passengers summary: Updates a notification timed event for a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEventsSet' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_put parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The notification timed event type. \nEnumeration values: 0 =\ \ Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 requestBody: x-name: request description: The updated notification timed event request. content: application/json: schema: $ref: '#/components/schemas/NotificationTimedEventEditRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a notification timed event from a specific passenger travel notification on the booking in state. description: 'GraphQL endpoint: passengerNotificationTimedEventsDelete' operationId: nsk_v1_booking_passengers_passengerAlternateKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_delete parameters: - name: passengerAlternateKey in: path required: true description: The passenger alternate key. This key will be null until the booking is committed. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The notification timed event type. \nEnumeration values: 0 =\ \ Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}: get: tags: - booking/passengers summary: Gets a specific passenger on the booking. description: 'GraphQL endpoint: passenger' operationId: nsk_v1_booking_passengers_passengerKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassenger' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/passengers/{passengerKey}: put: tags: - booking/passengers summary: Updates a specific passenger on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoints: passengerSetv4, passengersSetBatchv2' operationId: nsk_v3_booking_passengers_passengerKey_put parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: waiveNameChangeFees in: query description: Waive the name change fees. schema: type: boolean nullable: true x-position: 2 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\n\ documents' gender. This will update the gender of all the travel documents\ \ in the\npassengers[passengerKey].travelDocuments list in the booking model.\ \ The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The modified passenger request. content: application/json: schema: $ref: '#/components/schemas/PassengerBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Updated: description: The passenger has been updated. value: data: null Valid declared gender mapped to a different binary gender: description: Example response for successfully updating or modifying a passenger with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Example response for successfully updating or modifying a passenger with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: Example response when the declared gender in the request is more than 2 characters. value: errors: - id: null code: PassengerInformation.DeclaredGender:StringLengthAttribute message: The field PassengerInformation must be a string with a maximum length of 2. type: Validation details: member: DeclaredGender model: PassengerInformation validation: StringLengthAttribute rawMessage: The field PassengerInformation must be a string with a maximum length of 2. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: Example response when the declared gender in the request is inactive or non-existent. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Passenger John Doe has an invalid Declared Gender K. type: Validation details: message: Passenger John Doe has an invalid Declared Gender K. rawMessage: Passenger John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a specific passenger on the booking. description: 'Please note, the API will perform validation for the same properties that are on both the PATCH request and the existing passenger. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoints: passengerModifyv4, passengersModifyBatchv2' operationId: nsk_v3_booking_passengers_passengerKey_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: waiveNameChangeFees in: query description: Waive the name change fee. If unprovided, defaults to the configuration value. schema: type: boolean nullable: true x-position: 2 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\n\ documents' gender. This will update the gender of all the travel documents\ \ in the\npassengers[passengerKey].travelDocuments list in the booking model.\ \ The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The patched passenger request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPassengerBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Updated: description: The passenger has been updated. value: data: null Valid declared gender mapped to a different binary gender: description: Example response for successfully updating or modifying a passenger with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Example response for successfully updating or modifying a passenger with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: Example response when the declared gender in the request is more than 2 characters. value: errors: - id: null code: core:Validation:InvalidJsonSchema message: 'Invalid Json Schema. Line: #/info - NotOneOf.' type: Validation details: null rawMessage: 'Invalid Json Schema. Line: #/info - NotOneOf.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: Example response when the declared gender in the request is inactive or non-existent. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Passenger John Doe has an invalid Declared Gender K. type: Validation details: message: Passenger John Doe has an invalid Declared Gender K. rawMessage: Passenger John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null First passenger is not allowed to be TBA and is set as TBA: description: Example error when first passenger is not allowed to be TBA and its first or last name is set to "TBA". Please see GET /settings/booking/passenger for the configuration. value: errors: - id: null code: nsk:GroupBooking:GroupNameUpdateNotAllowed message: The first Pax is not allowed to be listed as TBA. type: Validation details: null rawMessage: The first Pax is not allowed to be listed as TBA. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Passengers are not allowed to be TBA and at least one passenger is set to TBA: description: Example error when passengers are not allowed to be TBA and at least one passenger's first or last name is set to "TBA". Please see GET /settings/booking/passenger for the configuration. value: errors: - id: null code: nsk:GroupBooking:GroupNameUpdateNotAllowed message: No passengers are allowed to be listed as TBA. type: Validation details: null rawMessage: No passengers are allowed to be listed as TBA. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/addresses: get: tags: - booking/passengers summary: Gets the collection of addresses from a specific passenger. description: Gets the collection of addresses from a specific passenger. operationId: nsk_v1_booking_passengers_passengerKey_addresses_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerAddress' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/addresses: post: tags: - booking/passengers summary: Creates a new address for a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerAddressAddv2' operationId: nsk_v2_booking_passengers_passengerKey_addresses_post parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 requestBody: x-name: request description: The new address request. content: application/json: schema: $ref: '#/components/schemas/PassengerAddressCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/addresses/{addressKey}: get: tags: - booking/passengers summary: Gets a specific address from a specific passenger. description: 'GraphQL endpoint: passengerAddress' operationId: nsk_v1_booking_passengers_passengerKey_addresses_addressKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: addressKey in: path required: true description: The unique address key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerAddress' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/passengers/{passengerKey}/addresses/{addressKey}: put: tags: - booking/passengers summary: Updates a specific address on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerAddressSetv3' operationId: nsk_v3_booking_passengers_passengerKey_addresses_addressKey_put parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: addressKey in: path required: true description: The unique address key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified address. content: application/json: schema: $ref: '#/components/schemas/PassengerAddressEditRequestv2' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a specific address on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerAddressModifyv3' operationId: nsk_v3_booking_passengers_passengerKey_addresses_addressKey_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: addressKey in: path required: true description: The unique address key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched address. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPassengerAddressEditRequestv2' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/addresses/{addressKey}: delete: tags: - booking/passengers summary: Deletes a specific address on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerAddressDeletev2' operationId: nsk_v2_booking_passengers_passengerKey_addresses_addressKey_delete parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: addressKey in: path required: true description: The unique address key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/baggage: get: tags: - booking/passengers summary: Gets all the baggage for a specified passenger. description: Gets all the baggage for a specified passenger. operationId: nsk_v1_booking_passengers_passengerKey_baggage_get parameters: - name: passengerKey in: path required: true description: The unique identifier for the passenger to get baggage for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerBag' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/baggage/{baggageKey}: get: tags: - booking/passengers summary: Retrieve a single bag from a specific passenger. description: 'GraphQL endpoint: passengerBag' operationId: nsk_v1_booking_passengers_passengerKey_baggage_baggageKey_get parameters: - name: passengerKey in: path required: true description: The passenger key for the passenger to retrieve from. schema: type: string x-position: 1 - name: baggageKey in: path required: true description: The bag key for the bag to retrieve. schema: type: string x-position: 2 responses: '200': description: OK. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerBag' '404': description: Bag was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/baggage/{baggageKey}/events: get: tags: - booking/passengers summary: Retrieves events for a specific passenger baggage. description: 'GraphQL endpoint: passengerBagEvents' operationId: nsk_v1_booking_passengers_passengerKey_baggage_baggageKey_events_get parameters: - name: passengerKey in: path required: true description: Passenger key. schema: type: string x-position: 1 - name: baggageKey in: path required: true description: Baggage key. schema: type: string x-position: 2 - name: StartDate in: query description: "Start date. If no start date is provided, the start date defaults\ \ to the current UTC-based date.\n " schema: type: string format: date-time nullable: true x-position: 3 - name: EndDate in: query description: "End date. If no end date is provided, the end date defaults\ \ to the current UTC-based date.\n " schema: type: string format: date-time nullable: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBaggageEventResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: 'Creates event information for a specific passenger baggage. A successful call immediately creates the event and does not require the booking to be committed.' description: 'GraphQL endpoint: passengerBagEventAdd' operationId: nsk_v1_booking_passengers_passengerKey_baggage_baggageKey_events_post parameters: - name: passengerKey in: path required: true description: Passenger key. schema: type: string x-position: 1 - name: baggageKey in: path required: true description: Baggage key. schema: type: string x-position: 2 requestBody: x-name: request description: Baggage event create request. content: application/json: schema: $ref: '#/components/schemas/BaggageEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/baggage/{baggageKey}/events/{baggageEventKey}: get: tags: - booking/passengers summary: Retrieves information for a specific passenger baggage event. description: 'GraphQL endpoint: passengerBagEvent' operationId: nsk_v1_booking_passengers_passengerKey_baggage_baggageKey_events_baggageEventKey_get parameters: - name: passengerKey in: path required: true description: Passenger key. schema: type: string x-position: 1 - name: baggageKey in: path required: true description: Baggage key. schema: type: string x-position: 2 - name: baggageEventKey in: path required: true description: Baggage event key. schema: type: string x-position: 3 - name: StartDate in: query description: "Start date. If no start date is provided, the start date defaults\ \ to the current UTC-based date.\n " schema: type: string format: date-time nullable: true x-position: 4 - name: EndDate in: query description: "End date. If no end date is provided, the end date defaults\ \ to the current UTC-based date.\n " schema: type: string format: date-time nullable: true x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBaggageEvent' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/breakdown: get: tags: - booking/passengers summary: Gets a specific passenger price breakdown by passenger key. description: 'GraphQL endpoint: passengerBreakdown' operationId: nsk_v1_booking_passengers_passengerKey_breakdown_get parameters: - name: passengerKey in: path required: true description: The specific passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerPriceBreakdown' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/documents: get: tags: - booking/passengers summary: Gets a specific passenger's collection of travel documents. description: Gets a specific passenger's collection of travel documents. operationId: nsk_v1_booking_passengers_passengerKey_documents_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerTravelDocument' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/documents: post: tags: - booking/passengers summary: Create a new travel document for a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerTravelDocumentsAddv2' operationId: nsk_v2_booking_passengers_passengerKey_documents_post parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\n\ documents' gender. This will update the gender in the passengers[passengerKey]\ \ as well as the gender of the other\ntravel documents in the passengers[passengerKey].travelDocuments\ \ list in the booking model. The value defaults to\ntrue if not specified.\n\ \ " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The new travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerTravelDocumentCreatedResponse' examples: Passenger Travel Document Created: description: The passenger travel document has been created. value: data: passengerTravelDocumentKey: UCFVUyEg With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: passengerTravelDocumentKey: UCFVUyEg '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/documents/{travelDocumentKey}: get: tags: - booking/passengers summary: Gets a specific passenger's specific travel document. description: 'GraphQL endpoint: passengerTravelDocuments' operationId: nsk_v1_booking_passengers_passengerKey_documents_travelDocumentKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerTravelDocument' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/documents/{travelDocumentKey}: put: tags: - booking/passengers summary: Updates a specific passenger's travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerTravelDocumentsSetv2' operationId: nsk_v2_booking_passengers_passengerKey_documents_travelDocumentKey_put parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\n\ documents' gender. This will update the gender in the passengers[passengerKey]\ \ as well as the gender of the other\ntravel documents in the passengers[passengerKey].travelDocuments\ \ list in the booking model. The value defaults to\ntrue if not specified.\n\ \ " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The modified travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Travel Document Updated: description: The passenger travel document has been updated. value: data: null With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a specific passenger's travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerTravelDocumentsModifyv2' operationId: nsk_v2_booking_passengers_passengerKey_documents_travelDocumentKey_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\n\ documents' gender. This will update the gender in the passengers[passengerKey]\ \ as well as the gender of the other\ntravel documents in the passengers[passengerKey].travelDocuments\ \ list in the booking model. The value defaults to\ntrue if not specified.\n\ \ " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The patched travel document. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelDocumentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Travel Document Updated: description: The passenger travel document has been updated. value: data: null With mismatching passenger and travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a specific passenger's specific travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerTravelDocumentsDeletev2' operationId: nsk_v2_booking_passengers_passengerKey_documents_travelDocumentKey_delete parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/documents/check: get: tags: - booking/passengers summary: Gets the document check status for a specific passenger if there are any. description: 'Requires a committed booking in state. Requires document check to be enabled in government security configuration. Performs document check and returns the results as documentCheckStatus. More detailed information is intentionally not provided for security reasons. The designers of the client application will need to determine what to do with the different responses, in most cases the passenger will need to be assisted by an airport agent. For more specific requirements check the following endpoint GET/api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements. For configuration options please contact your CSDM. For full documentation see https://developer.navitaire.com/documentation/dotrez-api/how-to/adc. GraphQL endpoint: passengerDocumentCheck' operationId: nsk_v1_booking_passengers_passengerKey_documents_check_get parameters: - name: passengerKey in: path required: true description: The key of the passenger to perform the document check on. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDocumentCheckResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/emdCoupons: get: tags: - booking/passengers summary: Gets the collection of passenger EMD coupons for a specific passenger. description: 'GraphQL endpoint: passengerEmdCoupons' operationId: nsk_v1_booking_passengers_passengerKey_emdCoupons_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerEmdCoupon' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/emdCoupons/{passengerEmdCouponKey}: get: tags: - booking/passengers summary: Gets a specific passenger EMD coupon for a specific passenger. description: 'GraphQL endpoint: passengerEmdCoupon' operationId: nsk_v1_booking_passengers_passengerKey_emdCoupons_passengerEmdCouponKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: passengerEmdCouponKey in: path required: true description: The unique passenger EMD coupon key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerEmdCoupon' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/fees: get: tags: - booking/passengers summary: Gets all fees for a specific passenger, based upon the given passenger key. description: 'GraphQL endpoint: passengerFees' operationId: nsk_v1_booking_passengers_passengerKey_fees_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerFee' examples: Retrieve passenger fees response: description: Example response for successfully retrieving the passenger fees. value: data: - type: 7 ssrCode: null ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: true isConfirmingExternal: false code: NFSF detail: null passengerFeeKey: MCEwITc- override: false flightReference: null note: b createdDate: '2025-03-26T05:24:42.7610199+00:00' isProtected: false serviceCharges: - amount: 0.0 code: NFSF detail: for free type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.0 ticketCode: NSF - type: 5 ssrCode: null ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: true isConfirmingExternal: false code: CHF1 detail: 26Mar NV2033 SLCDEN passengerFeeKey: MCExITU- override: false flightReference: 20250326 NV2033 SLCDEN note: a createdDate: '2025-03-26T05:27:52.1473296+00:00' isProtected: true serviceCharges: - amount: 50.0 code: CHF1 detail: Change Fee type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 50.0 ticketCode: CHF No passenger fees response: description: Example response when there are no fees associated with the passenger. value: data: [] '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No booking in state: description: Example error when there is no booking in state. value: errors: - id: 4d8dbf9a-ea54-6c63-e755-da5c0328543d code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid passenger key: description: Example error when the passenger key is invalid or does not exist in the booking in state. value: errors: - id: 1c2e93af-10dd-3da9-56ae-d1e50e731906 code: nsk:Exceptions:InvalidKey message: The identifier 'passengerKey' with value 'MCF' is invalid. type: Validation details: null rawMessage: The identifier 'passengerKey' with value 'MCF' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/booking/passengers/{passengerKey}/fees/{passengerFeeKey}: get: tags: - booking/passengers summary: Gets a specific fee for a specific passenger, based upon the given keys. description: 'GraphQL endpoint: passengerFee' operationId: nsk_v1_booking_passengers_passengerKey_fees_passengerFeeKey_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: passengerFeeKey in: path required: true description: The passenger fee key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerFee' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/fees/nameChange: delete: tags: - booking/passengers summary: Waives the name change fee of the specified passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerNameChangeFeeDelete' operationId: nsk_v1_booking_passengers_passengerKey_fees_nameChange_delete parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/fees/quote: get: tags: - booking/passengers summary: Gets the override fee quote of a new fee. description: 'GraphQL endpoint: overrideNewFeeQuote' operationId: nsk_v1_booking_passengers_passengerKey_fees_quote_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: FeeCode in: query description: "The fee code used to identify the fee being overridden.\n \ \ \nCurrently, only manually-added fees are supported for quoting\ \ new fee overrides.\nThese fee types are:\n- Service Fee\n- Non-Flight\ \ Service Fee\n- Penalty Fee\n- Spoilage Fee\n " schema: type: string maxLength: 6 minLength: 0 nullable: true x-position: 2 - name: PricingMode in: query description: "Indicates if fees are to be paid in points or with currency\n\ \ \nEnumeration values: 0 = MonetaryOnly, 1 = PointsOnly" schema: $ref: '#/components/schemas/FeePricingMode' x-position: 3 - name: OriginStation in: query description: "Originating station code of the booking where the fee will be\ \ applied.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 4 - name: Amount in: query description: "The override amount.\n " schema: type: number format: decimal nullable: true x-position: 5 - name: CollectedCurrencyCode in: query description: "The collected currency code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGetOverrideFeeQuoteResponse' examples: Retrieve Override Fee Quote Response: description: Example response for successfully retrieving the override fee quote response. value: data: feeOverrideCharges: - amount: 100.0 code: NFSF detail: Non Flight type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 100.0 ticketCode: NSF '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: Example Error if there is no booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Passenger Key: description: Example Error if passenger key is invalid. value: errors: - id: 2987bed7-5690-5050-55e9-819b8551b344 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'PassengerKey' with value 'MCFBASDFRFQ-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Currency Code: description: Example Error if the currency code is invalid. value: errors: - id: 10daf3f4-82c2-cf99-21ba-169fadae0b10 code: nsk:Validation:UnknownSellCurrencyCode message: nsk:Validation:UnknownSellCurrencyCode type: Validation details: currencyCode: SDK rawMessage: The currency code SDK does not exist or is not active. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Fee Key: description: Example Error if fee key is invalid. value: errors: - id: ea9e908c-8979-85d8-c9ed-886014d6fc46 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'FeeKey' with value 'MT21XF' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Fee Code: description: Example Error if the fee code is not allowed to be quoted. value: errors: - id: bf7c1a48-a4bf-ddf7-2413-93959ba6a3b3 code: nsk-server:FeeCalculation message: nsk-server:FeeCalculation type: Validation details: null rawMessage: Cannot quote overrides of type NameChangeFee for new fees. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Null Fee Code: description: Example Error if the fee code is null value: errors: - id: 6b34775e-d264-f3a6-4034-62daf6699617 code: GetNewOverrideFeeQuoteRequestBase.FeeCode:RequiredAttribute message: The GetNewOverrideFeeQuoteRequestBase field is required. type: Validation details: validation: RequiredAttribute model: GetNewOverrideFeeQuoteRequestBase member: FeeCode rawMessage: The GetNewOverrideFeeQuoteRequestBase field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Null Fee Amount: description: Example Error if the fee amount is null value: errors: - id: 6b34775e-d264-f3a6-4034-62daf6699617 code: GetNewOverrideFeeQuoteRequestBase.FeeCode:RequiredAttribute message: The GetNewOverrideFeeQuoteRequestBase field is required. type: Validation details: validation: RequiredAttribute model: GetNewOverrideFeeQuoteRequestBase member: Amount rawMessage: The GetNewOverrideFeeQuoteRequestBase field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Allow Negative Fees Role Setting Off: description: Example Error if the fee amount is negative or the fee type is not allowed to override, and the role setting is turned off. value: errors: - id: a49a0074-9b6d-9e30-83c3-1c21a56d748c code: nsk:Validation:RoleSettingsProhibit message: nsk:Validation:RoleSettingsProhibit type: Validation details: null rawMessage: Role settings prohibit a negative fee. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Inactive Fees: description: Example Error if the agent attempted to sell inactive fees. value: errors: - id: bee189bc-edfc-263b-edc1-33cbf8b709cf code: nsk:Fee:NotFound message: nsk:Fee:NotFound type: Validation details: null rawMessage: The fee was not found. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Unauthorized Overriding of Service Fees: description: Example Error if the agent is not authorized to override a service fee. value: errors: - id: 7911302f-46af-3dc8-5714-b2823fec853d code: nsk-server:AuthorizationSSRNotAllowed message: Agent is not authorized to override fees. type: Validation details: message: Agent is not authorized to override fees. rawMessage: Agent is not authorized to override fees. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Unauthorized Selling of Service Fees: description: Example Error if the agent is not authorized to sell a service fee. value: errors: - id: cfdacd38-5e2c-ab09-9fce-86722e945f0b code: nsk-server:AuthorizationServiceFeeNotAllowed message: Agent is not authorized to sell service fee FLO. type: Validation details: message: Agent is not authorized to sell service fee FLO. rawMessage: Agent is not authorized to sell service fee FLO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/infant: get: tags: - booking/passengers summary: Gets a specific passenger's infant. description: 'GraphQL endpoint: passengerInfant' operationId: nsk_v1_booking_passengers_passengerKey_infant_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerInfant' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/passengers/{passengerKey}/infant: post: tags: - booking/passengers summary: Creates an infant on a specific passenger. description: 'If the booking in state contains a passive segment, an infant will not be created on the passive segment for the passenger. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerInfantAddv3' operationId: nsk_v3_booking_passengers_passengerKey_infant_post parameters: - name: passengerKey in: path required: true description: The unique identifier of the passenger to which the infant will be added. schema: type: string x-position: 1 requestBody: x-name: request description: The new infant. content: application/json: schema: $ref: '#/components/schemas/PassengerInfantCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Valid declared gender mapped to the same binary gender: description: Successfully creating a passenger infant with a valid declared gender mapped to the same binary gender (i.e. Male to Undisclosed or Unspecified). value: data: null Valid declared gender mapped to a different binary gender: description: Successfully creating a passenger infant with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Successfully creating a passenger infant with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: The declared gender in the request is more than 2 characters. value: errors: - id: null code: PassengerInfantCreateRequest.DeclaredGender:StringLengthAttribute message: The field PassengerInfantCreateRequest must be a string with a maximum length of 2. type: Validation details: member: DeclaredGender model: PassengerInfantCreateRequest validation: StringLengthAttribute rawMessage: The field PassengerInfantCreateRequest must be a string with a maximum length of 2. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: The declared gender in the request is inactive or not configured in the system. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Infant John Doe has an invalid Declared Gender K. type: Validation details: message: Infant John Doe has an invalid Declared Gender K. rawMessage: Infant John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/passengers summary: Updates an infant on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantSetv3' operationId: nsk_v3_booking_passengers_passengerKey_infant_put parameters: - name: passengerKey in: path required: true description: The unique identifier of the passenger associated with the infant. schema: type: string x-position: 1 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel\ \ documents' gender. This will update the gender of\nall the travel documents\ \ in the passengers[passengerKey].infant.travelDocuments list in the booking\ \ model. The\nvalue defaults to true if not specified.\n " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The modified infant. content: application/json: schema: $ref: '#/components/schemas/Infant' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Valid declared gender mapped to the same binary gender: description: Successfully updating or modifying a passenger infant with a valid declared gender mapped to the same binary gender (i.e. Male to Undisclosed or Unspecified). value: data: null Valid declared gender mapped to a different binary gender: description: Successfully updating or modifying a passenger infant with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Successfully updating or modifying a passenger infant with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null Mismatching passenger infant and travel document declared gender: description: Successfully updating or modifying a passenger infant with a mismatching declared gender (Female) and travel document declared gender (Undisclosed). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value U. New Binary Gender: Male' status: 1 details: null - code: null type: FailedTravelDocValidation value: Infant (Doe, Justine) Gender doesn't match Travel Document (US, P, 1234567890) Gender status: 0 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: The declared gender in the request is more than 2 characters. value: errors: - id: null code: PassengerInfant.DeclaredGender:StringLengthAttribute message: The field PassengerInfant must be a string with a maximum length of 2. type: Validation details: member: DeclaredGender model: PassengerInfant validation: StringLengthAttribute rawMessage: The field PassengerInfant must be a string with a maximum length of 2. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: The declared gender in the request is inactive or not configured in the system. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Infant John Doe has an invalid Declared Gender K. type: Validation details: message: Infant John Doe has an invalid Declared Gender K. rawMessage: Infant John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/infant: patch: tags: - booking/passengers summary: Patches an infant on a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantModifyv2' operationId: nsk_v2_booking_passengers_passengerKey_infant_patch parameters: - name: passengerKey in: path required: true description: The unique identifier of the passenger associated with the infant. schema: type: string x-position: 1 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel\ \ documents' gender. This will update the gender of\nall the travel documents\ \ in the passengers[passengerKey].infant.travelDocuments list in the booking\ \ model. The\nvalue defaults to true if not specified.\n " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The patched infant. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfInfant' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Valid declared gender mapped to the same binary gender: description: Successfully updating or modifying a passenger infant with a valid declared gender mapped to the same binary gender (i.e. Male to Undisclosed or Unspecified). value: data: null Valid declared gender mapped to a different binary gender: description: Successfully updating or modifying a passenger infant with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: null Mismatching gender and declared gender: description: Successfully updating or modifying a passenger infant with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: null Mismatching passenger infant and travel document declared gender: description: Successfully updating or modifying a passenger infant with a mismatching declared gender (Female) and travel document declared gender (Undisclosed). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Infant Justine Doe - Binary Gender Female will be synced with Declared Gender value U. New Binary Gender: Male' status: 1 details: null - code: null type: FailedTravelDocValidation value: Infant (Doe, Justine) Gender doesn't match Travel Document (US, P, 1234567890) Gender status: 0 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid declared gender length: description: The declared gender in the request is more than 2 characters. value: errors: - id: null code: core:Validation:InvalidJsonSchema message: 'Invalid Json Schema. Line: #/declaredGender - NoTypeValidates.' type: Validation details: null rawMessage: 'Invalid Json Schema. Line: #/declaredGender - NoTypeValidates.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: The declared gender in the request is inactive or not configured in the system. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Infant John Doe has an invalid Declared Gender K. type: Validation details: message: Infant John Doe has an invalid Declared Gender K. rawMessage: Infant John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes an infant from a specific passenger. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantDeletev2' operationId: nsk_v2_booking_passengers_passengerKey_infant_delete parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/infant/documents: get: tags: - booking/passengers summary: Gets a specific passenger infant's collection of travel documents. description: Gets a specific passenger infant's collection of travel documents. operationId: nsk_v1_booking_passengers_passengerKey_infant_documents_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerTravelDocument' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/infant/documents: post: tags: - booking/passengers summary: Create a new travel document for a specific passenger infant. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantTravelDocumentsAddv2' operationId: nsk_v2_booking_passengers_passengerKey_infant_documents_post parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel\ \ documents' gender. This will update the gender in\nthe passengers[passengerKey].infant\ \ as well as the gender of the other travel documents in the\npassengers[passengerKey].infant.travelDocuments\ \ list in the booking model. The value defaults to true if not\nspecified.\n\ \ " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The new travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerTravelDocumentCreatedResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/infant/documents/{travelDocumentKey}: get: tags: - booking/passengers summary: Gets a specific passenger infant's specific travel document. description: 'GraphQL endpoint: passengerInfantTravelDocuments' operationId: nsk_v1_booking_passengers_passengerKey_infant_documents_travelDocumentKey_get parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerTravelDocument' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/infant/documents/{travelDocumentKey}: put: tags: - booking/passengers summary: Updates a specific passenger infant travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantTravelDocumentsSetv2' operationId: nsk_v2_booking_passengers_passengerKey_infant_documents_travelDocumentKey_put parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel\ \ documents' gender. This will update the gender in\nthe passengers[passengerKey].infant\ \ as well as the gender of the other travel documents in the\npassengers[passengerKey].infant.travelDocuments\ \ list in the booking model. The value defaults to true if not\nspecified.\n\ \ " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The modified travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking/passengers summary: Patches a specific passenger infant travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantTravelDocumentsModifyv2' operationId: nsk_v2_booking_passengers_passengerKey_infant_documents_travelDocumentKey_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 - name: syncInfantAndTravelDocGender in: query description: "Indicates whether to synchronize the infant and all its travel\ \ documents' gender. This will update the gender in\nthe passengers[passengerKey].infant\ \ as well as the gender of the other travel documents in the\npassengers[passengerKey].infant.travelDocuments\ \ list in the booking model. The value defaults to true if not\nspecified.\n\ \ " schema: type: boolean default: true x-position: 4 requestBody: x-name: request description: The patched travel document. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelDocumentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/passengers summary: Deletes a specific passenger infant specific travel document. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantTravelDocumentsDeletev2' operationId: nsk_v2_booking_passengers_passengerKey_infant_documents_travelDocumentKey_delete parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: travelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/infant/documents/check: get: tags: - booking/passengers summary: Gets the document check status for a specific passenger's infant if there are any. description: 'Requires a committed booking in state. Requires document check to be enabled in government security configuration. Performs document check and returns the results as documentCheckStatus. More detailed information is intentionally not provided for security reasons. The designers of the client application will need to determine what to do with the different responses, in most cases the passenger will need to be assisted by an airport agent. For more specific requirements check the following endpoint GET/api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements. For configuration options please contact your CSDM. For full documentation see https://developer.navitaire.com/documentation/dotrez-api/how-to/adc. GraphQL endpoint: passengerInfantDocumentCheck' operationId: nsk_v1_booking_passengers_passengerKey_infant_documents_check_get parameters: - name: passengerKey in: path required: true description: The key of the passenger to perform the infant document check on. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDocumentCheckResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/passengerTypeCode: patch: tags: - booking/passengers summary: Patches a specific passenger to the given passenger type. description: 'NOTE: The date of birth doesn''t need to be updated if the passenger''s current date of birth still falls within the new passenger type''s age restriction. This could also cause a repricing on the booking. In addition, changing the passenger type will change the passenger key as well. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerTypeCodeModify' operationId: nsk_v1_booking_passengers_passengerKey_passengerTypeCode_patch parameters: - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 1 - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\n\ documents' gender. This will update the gender of all the travel documents\ \ in the\npassengers[passengerKey].travelDocuments list in the booking model.\ \ The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 3 requestBody: x-name: request description: The passenger type request containing the new passenger type. content: application/json: schema: $ref: '#/components/schemas/PassengerTypeCodeEditRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerKeyResponse' examples: Passenger Type Code Modified: description: The passenger type code has been modified. value: data: oldPassengerKey: MCFBRFQ- newPassengerKey: MCFTTlI- With mismatching passenger travel document gender: description: The passenger gender does not match with the travel document, and the `syncPassengerAndTravelDocGender` is set to false. value: messages: - rawValue: Passenger (Doe, John) Gender doesn't match Travel Document (US, P, P123412341234) Gender code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedTravelDocValidation value: null status: 0 details: null data: oldPassengerKey: MCFBRFQ- newPassengerKey: MCFTTlI- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/seats: get: tags: - booking/passengers summary: Gets all seats associated with a passenger. description: 'GraphQL endpoint: seatPassengerv2' operationId: nsk_v2_booking_passengers_passengerKey_seats_get parameters: - name: passengerKey in: path required: true description: Passengers to get seats for. schema: type: string x-position: 1 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerSeat' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/seats/{unitKey}: delete: tags: - booking/passengers summary: Deletes a seat assignment from a specific passenger on the booking in state. description: 'GraphQL endpoint: seatDelete' operationId: nsk_v1_booking_passengers_passengerKey_seats_unitKey_delete parameters: - name: passengerKey in: path required: true description: The key for the passenger whose seat assignment is to be deleted. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unique unit key. schema: type: string x-position: 2 - name: WaiveFee in: query description: "The flag indicating to waive the seat fees if permissions permit.\n\ \ " schema: type: boolean nullable: true x-position: 3 - name: IgnoreSeatSsrs in: query description: "Flag indicating whether to ignore seat SSR's.\n " schema: type: boolean nullable: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/passengers/{passengerKey}/seats/{unitKey}: get: tags: - booking/passengers summary: Gets passenger seat by key. description: 'GraphQL endpoint: seatv2' operationId: nsk_v2_booking_passengers_passengerKey_seats_unitKey_get parameters: - name: passengerKey in: path required: true description: Unique passenger key. schema: type: string x-position: 1 - name: unitKey in: path required: true description: Unique unit key. schema: type: string x-position: 2 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSeat' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Adds a seat assignment to a specific passenger on the booking in state. description: 'This endpoint actively checks whether the passenger has a seat. If the passenger does have a seat, it will delete the current seat the passenger occupies and add the requested one. This may result in slightly slower response times. GraphQL endpoint: seatAddv2' operationId: nsk_v2_booking_passengers_passengerKey_seats_unitKey_post parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key. schema: type: string x-position: 2 requestBody: x-name: request description: The add seat request. content: application/json: schema: $ref: '#/components/schemas/AddSeatRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/{passengerKey}/seats/{unitKey}/quote: get: tags: - booking/passengers summary: Retrieves a seat fee quote for a specific passenger. description: 'GraphQL endpoint: seatFeeQuote' operationId: nsk_v1_booking_passengers_passengerKey_seats_unitKey_quote_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key. schema: type: string x-position: 2 - name: InventoryControlType in: query description: "The type of hold placed on seats.\n \nEnumeration\ \ values: 0 = Session, 1 = None" schema: nullable: true $ref: '#/components/schemas/UnitInventoryControlType' x-position: 3 - name: IgnoreSeatSSRs in: query description: "Determines whether or not SSRs associated with the seat will\ \ be ignored when determining\nunit availability.\n " schema: type: boolean nullable: true x-position: 4 - name: SeatAssignmentMode in: query description: "The seat assignment mode can affect available units in seat\ \ maps and whether or not\nseat fees are charged based on channel type,\ \ role settings, customer programs\nand/or class of service.\n \ \ \nEnumeration values: 0 = AutoDetermine, 1 = PreSeatAssignment, 2 =\ \ WebCheckIn" schema: nullable: true $ref: '#/components/schemas/SeatAssignmentMode' x-position: 5 - name: MonetaryOnly in: query description: "Indicates whether the fee to be priced is to be priced in money\ \ or points.\n " schema: type: boolean nullable: true x-position: 6 - name: CollectedCurrencyCode in: query description: "Optional currency code. If different than the booking currency\ \ code,\nfees in that currency will be returned if the conversion exists\ \ in the system.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSeatFee' examples: Retrieve Seat Fee Quote Response: description: Successful retrieval of the seat fee information of the specified passenger. value: data: type: 9 ssrCode: null ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: true isConfirmingExternal: false passengerKey: MCFBRFQ- code: JSF detail: null passengerFeeKey: MCEwITk- override: false flightReference: 20241111 NV5670 SLCBOS note: null createdDate: '2026-07-09T05:55:13.949142Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: null type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: PHP foreignAmount: 1435.0 ticketCode: JSF '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: No booking was put into state before retrieving a seat fee quote. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Passenger Key: description: The passenger key does not exist in the booking in state. value: errors: - id: 2987bed7-5690-5050-55e9-819b8551b344 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'PassengerKey' with value 'MCFBASDFRFQ-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Unit Key: description: The unit key is invalid and cannot be decoded properly. value: errors: - id: 2987bed7-5690-5050-55e9-819b8551b344 code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'unitKey' with value 'MS3NIP5DHgO9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Unconfigured Collected Currency Code: description: The collected currency code does not exist in the system or no conversion rate is found for the collected currency code. value: errors: - id: 62be6a4f-507b-a109-e082-2a2a1dd6a63e code: nsk-server:CurrencyConversionRateNotFound message: nsk-server:CurrencyConversionRateNotFound type: Information details: null rawMessage: No currency conversion rate found from USD to YER. You need to add this rate in Management Application. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Collected Currency Code Length: description: The collected currency code exceeds the maximum length. value: errors: - id: 169290f3-341a-c49e-f84c-c8049929b79f code: SeatFeeQuoteRequestv2.CollectedCurrencyCode:StringLengthAttribute message: The field SeatFeeQuoteRequestv2 must be a string with a maximum length of 3. type: Validation details: validation: StringLengthAttribute model: SeatFeeQuoteRequestv2 member: CollectedCurrencyCode rawMessage: The field SeatFeeQuoteRequestv2 must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking/passengers summary: Retrieves a seat fee quote for a specific passenger. description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. GraphQL endpoint: passengerSeatFeeQuote' operationId: nsk_v1_booking_passengers_passengerKey_seats_unitKey_quote_post parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key. schema: type: string x-position: 2 requestBody: x-name: request description: The seat fee quote request. content: application/json: schema: $ref: '#/components/schemas/SeatFeeQuoteRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSeatFee' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/passengers/{passengerKey}/ssrs/{ssrCode}/price: get: tags: - booking/passengers summary: Gets an SSR price quote on the booking in state. description: 'Requires a booking in state. GraphQL endpoint: passengerSsrPriceQuotes' operationId: nsk_v1_booking_passengers_passengerKey_ssrs_ssrCode_price_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: ssrCode in: path required: true description: The ssr code. schema: type: string x-position: 2 - name: collectedCurrencyCode in: query description: The collected currency code. schema: type: string nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsrPrice' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/passengers/{passengerKey}/ssrs/priceDetails: post: tags: - booking/passengers summary: Gets multiple SSR price quotes for the booking in state. description: 'Requires a booking in state. Due to the complexity of the request parameters, we use POST to allow for the request body to be used, even though this is actually a GET operation. This endpoint is related to the booking/ssrs/availability POST endpoint. This is a deep call to get the price details for specific SSR''s for a specific passenger, while the availability endpoint is a shallow call to get the available SSR''s and their associated prices. Submitting a request with SSR codes not found in the ssr availability call may not yield results from this endpoint. GraphQL endpoint: passengerSsrPriceQuotesBatch' operationId: nsk_v1_booking_passengers_passengerKey_ssrs_priceDetails_post parameters: - name: passengerKey in: path required: true description: The passenger key. These can be found on the /booking GET endpoint response. schema: type: string x-position: 1 requestBody: x-name: request description: The multiple SSR price request for a single passenger. content: application/json: schema: $ref: '#/components/schemas/PassengerSsrPriceRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfPassengerSsrPrice' examples: Retrieve SSR price details: description: Example response for successfully retrieving the passenger specific SSR price details. value: data: wchr: - passengerKey: MCFBRFQ- ssrPrices: - key: TlZ_NTY2NX4gfn5TTEN_MDMvMDUvMjAyNiAxNzowMH5CT1N_MDMvMDUvMjAyNiAyMzowMH5_ passengerFee: type: 6 ssrCode: WCHR ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: SSRF2 detail: An SSR detail passengerFeeKey: MCEwITY- override: false flightReference: ABC123 note: An SSR note createdDate: '2026-07-09T05:55:13.7433955Z' isProtected: false serviceCharges: - amount: 18.0 code: SSRF2 detail: SSR Fee type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 18.0 ticketCode: SF2 ssrType: 4 snep: - passengerKey: MCFBRFQ- ssrPrices: - key: TlZ_NTY2NX4gfn5TTEN_MDMvMDUvMjAyNiAxNzowMH5CT1N_MDMvMDUvMjAyNiAyMzowMH5_ passengerFee: type: 6 ssrCode: SNEP ssrNumber: 0 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: SSR detail: An SSR detail passengerFeeKey: MCEwITY- override: false flightReference: ABC123 note: An SSR note createdDate: '2026-07-09T05:55:13.7434388Z' isProtected: false serviceCharges: - amount: 0.0 code: SSR detail: Sfor free type: 6 collectType: 0 currencyCode: USD foreignCurrencyCode: EUR foreignAmount: 0.0 ticketCode: SSR ssrType: 3 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: Example Error if there is no booking in state. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Passenger Key: description: Example Error if passenger key is invalid. value: errors: - id: null code: nsk:Passenger:InvalidPassengerKey message: nsk:Passenger:InvalidPassengerKey type: Validation details: null rawMessage: The passenger key LDbRYqMVpNpe1y5UQkFRYqc is not valid for this booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid SSR Code: description: Example Error if the SSR code is invalid. value: errors: - id: null code: nsk:Ssrs:InvalidCode message: nsk:Ssrs:InvalidCode type: Validation details: null rawMessage: The SSR code TRSH is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With Invalid Currency Code: description: Example Error if the currency code is invalid. value: errors: - id: null code: nsk:Currency:InvalidCurrencyCode message: nsk:Currency:InvalidCurrencyCode type: Validation details: null rawMessage: The currency code Q is either invalid or inactive in the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Too many requested ssr codes: description: The number of SSR codes in the request exceeds the system defined maximum amount. value: errors: - id: null code: PassengerSsrPriceRequest.SsrCodes:MaxLengthAttribute message: The field PassengerSsrPriceRequest must be a string or array type with a maximum length of '20'. type: Validation details: null rawMessage: The field PassengerSsrPriceRequest must be a string or array type with a maximum length of '20'. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No SSR price details: description: Example response when there are no SSR price details available. value: data: null /api/nsk/v1/booking/passengers/{passengerKey}/voucher: get: tags: - booking/passengers summary: 'Gets information regarding a specific voucher code and passenger. Returns what a voucher can pay for a given passenger.' description: 'GraphQL endpoint: voucherByPassenger' operationId: nsk_v1_booking_passengers_passengerKey_voucher_get parameters: - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 1 - name: ReferenceCode in: query description: "The voucher reference code.\n " schema: type: string maxLength: 20 minLength: 1 nullable: true x-position: 2 - name: OverrideRestrictions in: query description: "Override restrictions. Defaults to false.\n " schema: type: boolean nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherInformation' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/baggage/group: get: tags: - booking/passengers summary: Gets baggage group membership for all passengers on booking in state, or predicts group membership if no current groups exist description: 'Call this before adding a bag to see what baggage group an added bag will be added to. Respects newskies configuration of baggage groups. Related endpoints: - PUT api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/group - GET /api/nsk/v1/booking/baggageAllowances - baggage allowances can have weight sharing by group behavior GraphQL endpoint: passengersBagGroups' operationId: nsk_v1_booking_passengers_baggage_group_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBaggageGroupMembership' examples: Retrieve baggage groups: description: Possible response for a booking with two segments and two passengers value: data: - baggageGroupNumber: 3 passengerKeys: - MCFBRFQ- - MSFBRFQ- segmentKeys: - TlZ_MTIyMX4gfn5KRkt_MDYvMDMvMjAyNSAwMTowMH5TTEN_MDYvMDMvMjAyNSAwMjowMH5_ - baggageGroupNumber: 1 passengerKeys: - MCFBRFQ- segmentKeys: - TlZ_MjAwOH4gfn5TTEN_MDYvMDUvMjAyNSAwODowMH5KRkt_MDYvMDUvMjAyNSAxNDowMH5_ - baggageGroupNumber: 2 passengerKeys: - MSFBRFQ- segmentKeys: - TlZ_MTIyMX4gfn5KRkt_MDYvMDMvMjAyNSAwMTowMH5TTEN_MDYvMDMvMjAyNSAwMjowMH5_ '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: No booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: No booking was found in session, cannot perform operation. type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. deprecated: true post: tags: - booking/passengers summary: 'Gets baggage group membership for selected passengers, or predicts group membership if no current groups exist. Structured as a POST but behaves as a GET.' description: 'Call this before adding a bag to see what baggage group an added bag will be added to. Respects newskies configuration of baggage groups. Related endpoints: - PUT api/nsk/v1/booking/journeys/{journeyKey}/passengers/{passengerKey}/baggage/group - GET /api/nsk/v1/booking/baggageAllowances - baggage allowances can have weight sharing by group behavior GraphQL endpoint: passengersBagGroupsList' operationId: nsk_v1_booking_passengers_baggage_group_post requestBody: x-name: passengerKeys description: List of passenger keys. If none are provided, gets all passengers on in-state booking. content: application/json: schema: type: array items: type: string required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBaggageGroupMembership' examples: Retrieve baggage groups: description: Possible response for a booking with two segments and two passengers value: data: - baggageGroupNumber: 3 passengerKeys: - MCFBRFQ- - MSFBRFQ- segmentKeys: - TlZ_MTIyMX4gfn5KRkt_MDYvMDMvMjAyNSAwMTowMH5TTEN_MDYvMDMvMjAyNSAwMjowMH5_ - baggageGroupNumber: 1 passengerKeys: - MCFBRFQ- segmentKeys: - TlZ_MjAwOH4gfn5TTEN_MDYvMDUvMjAyNSAwODowMH5KRkt_MDYvMDUvMjAyNSAxNDowMH5_ - baggageGroupNumber: 2 passengerKeys: - MSFBRFQ- segmentKeys: - TlZ_MTIyMX4gfn5KRkt_MDYvMDMvMjAyNSAwMTowMH5TTEN_MDYvMDMvMjAyNSAwMjowMH5_ '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With No Booking in State: description: No booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:NoBookingInState message: No booking was found in session, cannot perform operation. type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v1/booking/passengers/breakdown: get: tags: - booking/passengers summary: Gets all the passenger price breakdowns. description: Gets all the passenger price breakdowns. operationId: nsk_v1_booking_passengers_breakdown_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPassengerPriceBreakdown' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/breakdown/byType: get: tags: - booking/passengers summary: Gets all the passenger price breakdown by passenger type. description: Gets all the passenger price breakdown by passenger type. operationId: nsk_v1_booking_passengers_breakdown_byType_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPassengerTypePriceBreakdown' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/passengers/groupBooking: put: tags: - booking/passengers summary: Updates the collection of un-named or TBA passengers on the booking. description: 'When Enforce Standard Group Booking setting is true, group name is required and un-named or TBA passengers will be setup with First Name: TBA, Middle Name: Sequential Numeric, Last Name = Group Name. When the setting is false, group name is not required and passengers will be setup with First Name: Sequential Alphabetic, Last Name: TBA IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengersGroupBookingSet' operationId: nsk_v1_booking_passengers_groupBooking_put responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPassenger' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments: get: tags: - booking/payments summary: Retrieves the booking payments on the booking in state. description: Requires a booking in state. operationId: nsk_v1_booking_payments_get responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPayment' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v5/booking/payments: post: tags: - booking/payments summary: Creates a new external payment or prepaid payment on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` The payment fields are dynamic to the criteria of your payment provider. Here is an example request for a credit card payment that does not require address, zip, etc. { "amount": 10, "currencyCode": "USD", "paymentFields": {"ACCTNO":"411111111111", "EXPDATE":"10/8/2017", "CC::AccountHolderName":"Bob Smith", "CC::VerificationCode":"111"}} A 202 (HTTP status code) response returns alternate data signifying that either Three D Secure was enabled for this payment and is required for this payment type or a direct currency conversion (Dcc) offer was given. The payment will need to be resent using the 3DS endpoint or the Dcc endpoint. Note that it is possible for a payment to return a dcc offer and also have three d secure enabled. In these cases the direct currency conversion offer will need to be handled first and then the three d secure payment can be handled. If you would like to make a Dcc offer and the system using this endpoint cannot display a dcc offer to the end user, the status should be updated to DccNotOffered. This indicates that the offer was not displayed to the end user and is to be accepted automatically. If you would like to make a ThreeDSecure payment, you will need to provide a valid term url. You will also need to have these headers populated: User Agent (USER-AGENT) Accept (ACCEPT) This endpoint can also only be used with the v6 three d secure endpoint, POST `api/nsk/v6/booking/payments/threeDSecure`. GraphQL endpoint: paymentAddv5' operationId: nsk_v5_booking_payments_post parameters: - name: termUrl in: query description: The term URL. schema: type: string nullable: true x-position: 2 requestBody: x-name: request description: Payment request. content: application/json: schema: $ref: '#/components/schemas/PaymentMethodRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentInformation' examples: Three D Secure 1 Redirect needed: description: Example response for a Three D Secure 1 redirect is required. value: threeDSecureResponse: redirectUrl: https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA paReq: eNpdkl1PwjAUhu/7K4jxeu26gUoOTUAiHxGyyILgXe1OYMZ90G2A/952bKL26jyn57TnfVsI9xpxvEJVaRSwwKKQO+zE0eBGrTchn7JgVgSvz7v3XO3m7EZAMHzBg4Aj6iLOUuE6zOFAWyTmCK32Mi0FSHUYzZai2+16nge0QQIJ6tlYMLOAXmICqUxQLOUxLmWs0VFZArTOEVBZlZb6S9z7pr4FApX+FPuyzIs+pafTyfnXbLcJ0Os0QWWjwog8x5HYum/b9Xg+WzyN5sodbcJJFKvJMl19DAdAbQWBSJYoOOPcZczvuA997vd9F2idJyATO4u49bhjlTRIILcXDS/kcbv1O2P0VFpjqlpBLRHAc56laGqMnz+xGQMLJUIsSmbvtmB0XdU8Tq3TqjQ29liPu3e11TXXR8bGLe7Z3gZMt+2hzUPS5s1N9OcvfAMe8K4M responseUrl: null md: null raw:
paymentTransactionKey: Y1ZYVDJIMFBJc1BXTGdicGNnSjAhMSEtMSEtMSEtMSFYWFhYWFhYWFhYWFgwMDA3 threeDSecureVersion: '1.0' directCurrencyConversionOffer: null DCC Offer: description: Example response for when a DCC Offer is proposed. value: threeDSecureResponse: null directCurrencyConversionOffer: dccPaymentTransactionKey: MSFYWFhYWFhYWFhYWFg0NDQ0IUFVRCEyODA0LjAwITAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMA-- currencyCode: AUD rateValue: 2.0 amount: 2804.0 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Paying with a Blacklisted Card: description: Example response when attempting to pay with a blacklisted card without a reason. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is None. rawMessage: Blacklisted Card, the reason given is None. 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 Paying with a Lost Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as lost. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Lost. rawMessage: Blacklisted Card, the reason given is Lost. 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 Paying with a Stolen Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as stolen. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Stolen. rawMessage: Blacklisted Card, the reason given is Stolen. 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 Paying with a Chargedback Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as chargedback. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is ChargedBack. rawMessage: Blacklisted Card, the reason given is ChargedBack. 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 Inexistent or inactive payment method: description: Example response when the payment method is inexistent or inactive. Please see /resources/PaymentMethods for valid codes. value: errors: - id: null code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: '"The value ''DT'' is out of range for ''PaymentMethodRequest.PaymentMethodCode''.\nExpected values: (AC,AG,AP,AX,BD,BN,CA,CF,CK,DI,EA,EM,HP,IF,LP,LY,MC,OM,PP,PS,SO,SW,TA,TV,VI,VO)"' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/{paymentKey}: get: tags: - booking/payments summary: Gets a specific payment. description: 'GraphQL endpoint: payments' operationId: nsk_v1_booking_payments_paymentKey_get parameters: - name: paymentKey in: path required: true description: Payment key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPayment' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/payments summary: Deletes the payment. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: paymentDelete' operationId: nsk_v1_booking_payments_paymentKey_delete parameters: - name: paymentKey in: path required: true description: Payment key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/payments/{paymentKey}/authorize: patch: tags: - booking/payments summary: Manually authorize a committed payment. description: 'NOTE: This endpoint takes a singular property for the request body and as such the request will need to be formatted differently than what it typically looks like. For more information, please see https://navitaire-developer-digital-api.azurewebsites.net/articles/Miscellaneous/UniqueInputSingleRequestBodiesREST and the Swagger request examples. This endpoint is to be used with caution and is only permissible to use under certain circumstances. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentAuthorizev3' operationId: nsk_v2_booking_payments_paymentKey_authorize_patch parameters: - name: paymentKey in: path required: true description: The payment key. schema: type: string x-position: 1 requestBody: x-name: authorizationCode description: The authorization code. content: application/json: schema: type: string examples: Manual Authorize JSON request body, with an authorization code: description: Example request for when you want to authorize a payment. value: ac89c98fdajldsfa required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/payments/{paymentKey}/decline: patch: tags: - booking/payments summary: Manually decline a committed payment. description: 'This endpoint is to be used with caution and is only permissible to use under certain circumstances. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentDeclinev3' operationId: nsk_v2_booking_payments_paymentKey_decline_patch parameters: - name: paymentKey in: path required: true description: The payment key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/{paymentMethod}/dcc: post: tags: - booking/payments summary: 'Gets the available direct currency codes offer. This is for making an inline DCC payment.' description: 'This endpoint behaves like a GET but is masked as a POST. If a DCC offer is accepted the payment transaction will need to be completed before getting another DCC offer. For example, a user cannot get a DCC offer for a VISA, get a DCC offer for a MasterCard and then accept the VISA DCC offer and pay with the VISA. The only way to complete this would be to get a DCC offer on one card, accept, and then pay and then get the DCC offer for another card, accept, and pay. Regardless of whether the offer is accepted or not, the endpoint /api/nsk/v6/booking/payments/dcc/{dccKey} will need to be called.' operationId: nsk_v1_booking_payments_paymentMethod_dcc_post parameters: - name: paymentMethod in: path required: true description: The payment method code. schema: type: string x-position: 1 requestBody: x-name: request description: The DCC availability request. content: application/json: schema: $ref: '#/components/schemas/DccAvailabilityBaseRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDirectCurrencyConversionAvailability' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/allocations: get: tags: - booking/payments summary: 'Gets the payment allocations for the booking in state. Payment allocations are a collection of the payments assigned to each passenger on the booking.' description: 'GraphQL endpoint: paymentAllocations' operationId: nsk_v1_booking_payments_allocations_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentAllocations' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/payments/available: get: tags: - booking/payments summary: Retrieves the booking payment methods available for the booking in state. description: 'Requires a booking in state. GraphQL endpoint: paymentsAvailablev2' operationId: nsk_v2_booking_payments_available_get parameters: - name: currencyCode in: query description: The optional currency code. Defaults to the logged in users currency code. schema: type: string nullable: true x-position: 1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPaymentMethod' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/blacklist: post: tags: - booking/payments summary: Adds the booking payment to the blacklist. description: 'GraphQL endpoint: paymentsBlacklistAdd' operationId: nsk_v1_booking_payments_blacklist_post requestBody: x-name: request description: The blacklist payment request. content: application/json: schema: $ref: '#/components/schemas/BlacklistPaymentEntry' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/blacklist/{paymentKey}: get: tags: - booking/payments summary: Retrieves the specified blacklisted payment. description: 'GraphQL endpoint: paymentsBlacklistGet' operationId: nsk_v1_booking_payments_blacklist_paymentKey_get parameters: - name: paymentKey in: path required: true description: The unique identifier of the blacklisted payment to retrieve. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBlacklistPaymentEntry' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true patch: tags: - booking/payments summary: Modifies the specified blacklisted payment. description: 'GraphQL endpoint: paymentsBlacklistModify' operationId: nsk_v1_booking_payments_blacklist_paymentKey_patch parameters: - name: paymentKey in: path required: true description: The unique identifier of the blacklisted payment to modify. schema: type: string x-position: 1 requestBody: x-name: request description: The modify blacklisted payment request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfBlacklistPaymentEntryEditRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/payments summary: Removes the specified payment from the blacklist. description: 'GraphQL endpoint: paymentsBlacklistDelete' operationId: nsk_v1_booking_payments_blacklist_paymentKey_delete parameters: - name: paymentKey in: path required: true description: 'The unique identifier of the payment to be removed from the blacklist. ' schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/payments/blacklist/{paymentKey}: get: tags: - booking/payments summary: Retrieves the specified blacklisted payment. description: 'GraphQL endpoint: paymentsBlacklistGetv2' operationId: nsk_v2_booking_payments_blacklist_paymentKey_get parameters: - name: paymentKey in: path required: true description: The unique identifier of the blacklisted payment to retrieve. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGetBlacklistPaymentEntryResponse' examples: Retrieve Blacklisted Payment: description: Successful retrieval of the blacklisted payment. value: data: reason: 2 notes: The credit card was lost startDate: '2026-07-10T05:55:13.7045443Z' endDate: '2026-07-14T05:55:13.7045567Z' paymentKey: MzU5NTcxITEhTUMhMzg1MjAy createdDate: '2026-07-09T05:55:13.7045061Z' modifiedDate: '2026-07-12T05:55:13.7045291Z' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Payment Not Found: description: Payment key does not exist in the booking in state value: errors: - code: nsk:Payment:PaymentKeyNotFoundOnBooking message: The payment key FdZvq0FzTaNkJ8M6dKtU is not found on the booking in state. type: Validation number: null details: paymentKey: FdZvq0FzTaNkJ8M6dKtU No Booking in State: description: No booking was put into state before retrieving a blacklisted payment. value: errors: - code: nsk:Booking:NoBookingInState message: No booking was found in session, cannot perform operation. type: Validation number: null details: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/payments/bookingCredit: get: tags: - booking/payments summary: Gets credit available from a past booking. description: 'See booking retrieve. This method uses the same validation rules. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentBookingCreditsv3' operationId: nsk_v2_booking_payments_bookingCredit_get parameters: - name: CurrencyCode in: query description: "The currency code of the account.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 1 - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: string maxLength: 12 minLength: 0 nullable: true x-position: 2 - name: EmailAddress in: query description: "The email address of a contact.\n " schema: type: string maxLength: 266 minLength: 0 nullable: true x-position: 3 - name: Origin in: query description: "The origin station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 4 - name: FirstName in: query description: "The first name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 5 - name: LastName in: query description: "The last name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 6 - name: CustomerNumber in: query description: "One of the passengers customer numbers applied.\n \ \ " schema: type: string maxLength: 20 minLength: 0 nullable: true x-position: 7 - name: DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 8 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCreditAccount' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid search criteria: description: The search parameters used did not meet the configured strategy in the Management Console. For more information about setting up the strategies, please refer to the Navitaire Developer Portal. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: Invalid search criteria 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 Validation failed: description: The booking associated with the record locator is not found or the provided search parameters didn't match with the booking. The value for the `rawMessage` might differ depending on the strategy used. Aside from the first and last name, it could be email, customer number, last name or origin and departure date. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: First and last name validation failed 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 Agent not allowed to view past-dated bookings: description: The agent is not allowed to retrieve past-dated bookings that are outside the configured number of days in the Management Console. value: errors: - id: null code: nsk-server:AuthorizationViewPastDatedBookingNotAllowed message: nsk-server:AuthorizationViewPastDatedBookingNotAllowed type: Validation details: null rawMessage: Agent is not allowed to retrieve the booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/payments/bookingCredit: post: tags: - booking/payments summary: Applies credit from a past booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: paymentBookingCreditsAddv4' operationId: nsk_v3_booking_payments_bookingCredit_post requestBody: x-name: request description: Apply booking credit request. content: application/json: schema: $ref: '#/components/schemas/ApplyBookingCreditRequestv2' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid search criteria: description: The search parameters used did not meet the configured strategy in the Management Console. For more information about setting up the strategies, please refer to the Navitaire Developer Portal. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: Invalid search criteria 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 Validation failed: description: The booking associated with the record locator is not found or the provided search parameters didn't match with the booking. The value for the `rawMessage` might differ depending on the strategy used. Aside from the first and last name, it could be email, customer number, last name or origin and departure date. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: First and last name validation failed 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 Agent not allowed to view past-dated bookings: description: The agent is not allowed to retrieve past-dated bookings that are outside the configured number of days in the Management Console. value: errors: - id: null code: nsk-server:AuthorizationViewPastDatedBookingNotAllowed message: nsk-server:AuthorizationViewPastDatedBookingNotAllowed type: Validation details: null rawMessage: Agent is not allowed to retrieve the booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/payments/credit: post: tags: - booking/payments summary: Applies credit by reference number and type. description: 'This endpoint is for agents and can apply credit for any user or type. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentCreditsAddv3' operationId: nsk_v3_booking_payments_credit_post requestBody: x-name: request description: Apply credit request. content: application/json: schema: $ref: '#/components/schemas/ApplyCreditAccountRequestv2' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/payments/credit: get: tags: - booking/payments summary: Gets credit available by reference number and type. description: 'This endpoint is for agents and can get credit available for any user or type. GraphQL endpoint: paymentCreditsv2' operationId: nsk_v2_booking_payments_credit_get parameters: - name: ReferenceNumber in: query description: "The account reference. This will be the record locator, customer\ \ account number, or organization code depending on\nthe type.\n \ \ " schema: type: string maxLength: 20 minLength: 1 nullable: true x-position: 1 - name: CurrencyCode in: query description: "The currency code of the account.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: Type in: query description: "Defines the type of credit being applied.\n \nEnumeration\ \ values: 0 = Customer, 1 = Booking, 2 = Organization" schema: $ref: '#/components/schemas/CreditType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCreditAccount' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/payments/customerCredit: post: tags: - booking/payments summary: Applies credit from the logged in customer to the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: paymentCustomerCreditsAddv3' operationId: nsk_v3_booking_payments_customerCredit_post requestBody: x-name: request description: Apply credit request. content: application/json: schema: $ref: '#/components/schemas/ApplyCreditRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/payments/customerCredit: get: tags: - booking/payments summary: Gets credit available for the logged in user on the booking in state. description: 'Depending on configuration, credit may be validated by the contacts and passengers on the booking. GraphQL endpoint: paymentCustomerCreditsv2' operationId: nsk_v2_booking_payments_customerCredit_get parameters: - name: CurrencyCode in: query description: "The currency code of the account.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCreditAccount' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v6/booking/payments/dcc/{dccKey}: post: tags: - booking/payments summary: 'Creates a new external payment with direct currency conversion. This endpoint is used for inline DCC payments only.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` If a DCC offer is accepted the payment transaction will need to be completed before getting another DCC offer. For example, a user cannot get a DCC offer for a VISA, get a DCC offer for a MasterCard and then accept the VISA DCC offer and pay with the VISA. The only way to complete this would be to get a DCC offer on one card, accept, and then pay and then get the DCC offer for another card, accept, and pay. Regardless of whether the offer is accepted or not, the endpoint /api/nsk/v5/booking/payments/dcc/{dccKey} will need to be called. If you would like to make a ThreeDSecure payment, you will need to provide a valid term url. You will also need to have these headers populated: User Agent (USER-AGENT) Accept (ACCEPT) GraphQL endpoint: paymentDccAddv6' operationId: nsk_v6_booking_payments_dcc_dccKey_post parameters: - name: dccKey in: path required: true description: The DCC key. schema: type: string x-position: 1 - name: termUrl in: query description: The term url. schema: type: string nullable: true x-position: 3 requestBody: x-name: request description: The DCC request. content: application/json: schema: $ref: '#/components/schemas/DccRequestBasev2' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfThreeDSecureResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Paying with a Blacklisted Card: description: Example response when attempting to pay with a blacklisted card without a reason. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is None. rawMessage: Blacklisted Card, the reason given is None. 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 Paying with a Lost Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as lost. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Lost. rawMessage: Blacklisted Card, the reason given is Lost. 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 Paying with a Stolen Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as stolen. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Stolen. rawMessage: Blacklisted Card, the reason given is Stolen. 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 Paying with a Chargedback Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as chargedback. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is ChargedBack. rawMessage: Blacklisted Card, the reason given is ChargedBack. 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 Inexistent or inactive payment method: description: Example response when the payment method is inexistent or inactive. Please see /resources/PaymentMethods for valid codes. value: errors: - id: null code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: '"The value ''DT'' is out of range for ''PaymentMethodRequest.PaymentMethodCode''.\nExpected values: (AC,AG,AP,AX,BD,BN,CA,CF,CK,DI,EA,EM,HP,IF,LP,LY,MC,OM,PP,PS,SO,SW,TA,TV,VI,VO)"' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/booking/payments/dcc/{dccPaymentTransactionKey}: post: tags: - booking/payments summary: Adds a dcc payment to the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` NOTE: This endpoint takes a singular property for the request body and as such the request will need to be formatted differently than what it typically looks like. For more information, please see https://navitaire-developer-digital-api.azurewebsites.net/articles/Miscellaneous/UniqueInputSingleRequestBodiesREST and the Swagger request examples. If the system using this endpoint cannot display a dcc offer to the end user, the status should be updated to DccNotOffered. This indicates that the offer was not displayed to the end user and is it to be accepted automatically. A 202 (HTTP status code) response returns alternate data signifying that Three D Secure was enabled for this payment and is required for this payment type. The payment will need to be resent using the 3DS endpoint. If you would like to make a ThreeDSecure payment, you will need to provide a valid term url. You will also need to have these headers populated: User Agent (USER-AGENT) Accept (ACCEPT)' operationId: nsk_v1_booking_payments_dcc_dccPaymentTransactionKey_post parameters: - name: dccPaymentTransactionKey in: path required: true description: The dcc payment transaction key. schema: type: string x-position: 1 requestBody: x-name: status description: The dcc status. content: application/json: schema: type: string examples: Accepting a Dcc Offer JSON request body, 1: description: Example request for when wanting to accept a dcc offer. value: 2 Accepting a Dcc Offer JSON request body, 2: description: Example request for when wanting to accept a dcc offer. value: DccOfferAccepted required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfThreeDSecureResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/fees/{feeCode}: post: tags: - booking/payments summary: 'Retrieves the payment fee for the fee code by providing the account number and payment method code for a manual form of payment.' description: 'This endpoint behaves like a GET endpoint but is masked as POST. GraphQL endpoint: paymentFeeManual' operationId: nsk_v1_booking_payments_fees_feeCode_post parameters: - name: feeCode in: path required: true description: The feeCode. schema: type: string x-position: 1 requestBody: x-name: request description: The payment fee price request. content: application/json: schema: $ref: '#/components/schemas/ManualPaymentFeeRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentFeeResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/fees/{feeCode}/storedPayment/{storedPaymentKey}: get: tags: - booking/payments summary: 'Retrieves the payment fee for the fee code by providing the stored payment key for a stored payment. The stored payment key will be able to provide to retrieve the account number, payment method code and account number id.' description: 'GraphQL endpoint: paymentFeeStored' operationId: nsk_v1_booking_payments_fees_feeCode_storedPayment_storedPaymentKey_get parameters: - name: feeCode in: path required: true description: The fee code. schema: type: string x-position: 1 - name: storedPaymentKey in: path required: true description: The stored payment key of the agent holding the session. schema: type: string x-position: 2 - name: Amount in: query description: "The amount being payed.\n " schema: type: number format: decimal x-position: 3 - name: CurrencyCode in: query description: "The currency code. This will default to the bookings currency\ \ code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 4 - name: CollectedCurrencyCode in: query description: "The optional collected currency code. This will be needed for\ \ MCC requests.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentFeeResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/inProcess: delete: tags: - booking/payments summary: 'Cancels an in-process payment, if one exists, from the session state. This can be used when in the middle of a 3DS, MCC, or DCC payment to remove the payment.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: inProcessPaymentDelete' operationId: nsk_v1_booking_payments_inProcess_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/payments/mcc: get: tags: - booking/payments summary: Gets the available multi-currency codes available. description: 'This is affected by the booking currency code. GraphQL endpoint: paymentMccAvailabilityv3' operationId: nsk_v3_booking_payments_mcc_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndMccCurrencyInformationv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v6/booking/payments/mcc/{currencyCode}: post: tags: - booking/payments summary: Creates a new MCC payment. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This is affected by the booking currency code. The MCC payment cannot have the same currency code in the URL and body. In a normal MCC rate scenario, the rate ID and exchange rate payment fields are auto-populated and should not be passed in manually. If you would like to make a ThreeDSecure payment, you will need to provide a valid term url. You will also need to have these headers populated: User Agent Accept GraphQL endpoint: paymentMccAddv6' operationId: nsk_v6_booking_payments_mcc_currencyCode_post parameters: - name: currencyCode in: path required: true description: The collected currency code. schema: type: string x-position: 1 - name: termUrl in: query description: The term URL. schema: type: string nullable: true x-position: 3 requestBody: x-name: request description: The payment method request. content: application/json: schema: $ref: '#/components/schemas/MccPaymentMethodRequest' examples: Normal MCC Payment Request: description: Example request for making a normal MCC payment. value: thirdPartyExternalRate: null paymentMethodCode: MC amount: 5.0 deposit: null paymentFields: acctno: '5210000010001001' cC::AccountHolderName: Jim Bob cC::VerificationCode: '123' waiveFees: false currencyCode: null installments: null Third Party External Rate MCC Payment Request: description: NOT RECOMMENDED TO USE. Example request for making an Mcc payment with a third party external rate. value: thirdPartyExternalRate: rateId: v2I0fC quotedCurrency: USD collectedCurrency: AUD exchangeRate: 1.31 paymentMethodCode: MC amount: 5.0 deposit: null paymentFields: acctno: '5210000010001001' cC::AccountHolderName: Jim Bob cC::VerificationCode: '123' waiveFees: null currencyCode: null installments: null required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfThreeDSecureResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Paying with a Blacklisted Card: description: Example response when attempting to pay with a blacklisted card without a reason. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is None. rawMessage: Blacklisted Card, the reason given is None. 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 Paying with a Lost Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as lost. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Lost. rawMessage: Blacklisted Card, the reason given is Lost. 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 Paying with a Stolen Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as stolen. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Stolen. rawMessage: Blacklisted Card, the reason given is Stolen. 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 Paying with a Chargedback Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as chargedback. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is ChargedBack. rawMessage: Blacklisted Card, the reason given is ChargedBack. 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 Collected currency code is null: description: Example response when the collected currency code is null. It can be set to null by setting it to a URL encoded space value `%20`. value: errors: - id: null code: nsk:Payment:FieldInvalid message: nsk:Payment:FieldInvalid type: Error details: null rawMessage: The payment field is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid payment method code: description: 'Example response when the payment method code is invalid. Invalid can mean the following: inactive, non-existent, payment method type is not external account, unallowed for the role, or unallowed for the request currency code. Please see /resources/PaymentMethods for valid codes.' value: errors: - id: null code: nsk:Payment:FieldInvalid message: nsk:Payment:FieldInvalid type: Error details: null rawMessage: The payment field MC is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Request currency code and collected currency code are the same: description: Example response when the request currency code and collected currency code are the same. value: errors: - id: null code: nsk:Payment:FieldInvalid message: nsk:Payment:FieldInvalid type: Error details: null rawMessage: MCC currency code cannot be the same as the payment currency code. 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 Request currency code and collected currency code are not configured in the external rates: description: Example response when the request currency code and collected currency code are not configured in the external rates. Please see resources/ExternalRates for valid currencies. value: errors: - id: null code: nsk:Payment:FieldInvalid message: nsk:Payment:FieldInvalid type: Error details: null rawMessage: The payment field PHP is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v6/booking/payments/mcc/{currencyCode}/storedPayment/{storedPaymentKey}: post: tags: - booking/payments summary: Creates a new MCC payment from a stored payment. description: 'IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. This is affected by the booking currency code. The MCC payment cannot have the same currency code in the URL and body. In a normal MCC rate scenario, the rate ID and exchange rate payment fields are auto-populated and should not be passed in manually. If you would like to make a ThreeDSecure payment, you will need to provide a valid term url. You will also need to have these headers populated: User Agent Accept GraphQL endpoint: paymentMccAddStoredv6' operationId: nsk_v6_booking_payments_mcc_currencyCode_storedPayment_storedPaymentKey_post parameters: - name: currencyCode in: path required: true description: The collected currency code. schema: type: string x-position: 1 - name: storedPaymentKey in: path required: true description: Stored payment key. schema: type: string x-position: 2 - name: termUrl in: query description: The term URL. schema: type: string nullable: true x-position: 4 requestBody: x-name: request description: The payment method request. content: application/json: schema: $ref: '#/components/schemas/MccPaymentRequest' examples: Normal MCC Stored Payment Request: description: Example request for making a normal MCC stored payment. value: thirdPartyExternalRate: null amount: 5.0 paymentFields: null currencyCode: null installments: null Third Party External Rate MCC Stored Payment Request: description: NOT RECOMMENDED TO USE. Example request for making an MCC stored payment with a third party external rate. value: thirdPartyExternalRate: rateId: v2I0fC quotedCurrency: USD collectedCurrency: AUD exchangeRate: 1.31 amount: 5.0 paymentFields: null currencyCode: null installments: null required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfThreeDSecureResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Paying with a Blacklisted Card: description: Example response when attempting to pay with a blacklisted card without a reason. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is None. rawMessage: Blacklisted Card, the reason given is None. 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 Paying with a Lost Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as lost. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Lost. rawMessage: Blacklisted Card, the reason given is Lost. 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 Paying with a Stolen Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as stolen. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Stolen. rawMessage: Blacklisted Card, the reason given is Stolen. 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 Paying with a Chargedback Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as chargedback. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is ChargedBack. rawMessage: Blacklisted Card, the reason given is ChargedBack. 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 Inexistent or inactive payment method: description: Example response when the payment method is inexistent or inactive. Please see /resources/PaymentMethods for valid codes. value: errors: - id: null code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: '"The value ''DT'' is out of range for ''PaymentMethodRequest.PaymentMethodCode''.\nExpected values: (AC,AG,AP,AX,BD,BN,CA,CF,CK,DI,EA,EM,HP,IF,LP,LY,MC,OM,PP,PS,SO,SW,TA,TV,VI,VO)"' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v3/booking/payments/organizationCredit: post: tags: - booking/payments summary: 'Applies credit to the logged-in or specified user''s organization. NOTE: It is not recommended to use a custom agency credit payment as it will not have the same behavior nor be validated like the pre-configured `AG` credit payment.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: paymentOrganizationCreditsAddv3' operationId: nsk_v3_booking_payments_organizationCredit_post requestBody: x-name: request description: Apply credit request. content: application/json: schema: $ref: '#/components/schemas/ApplyOrganizationCreditRequest' examples: Apply Organization Credit Request: description: Example request for applying credit to the user's organization. value: waiveFees: true amount: 100.0 currencyCode: USD organizationCreditCode: AG comment: Applying organization credit to the booking. accountReference: SYSTEM required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Inactive Payment Method: description: The payment method is unknown or inactive. value: errors: - id: null code: nsk-server:Payment:ValidationError:UnknownOrInactivePaymentMethod message: nsk-server:Payment:ValidationError:UnknownOrInactivePaymentMethod type: Validation details: null rawMessage: Unknown or Inactive PaymentMethod 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. With Payment Method Not Allowed: description: The payment method is not allowed for the role. value: errors: - id: null code: nsk-server:Payment:ValidationError:PaymentMethodNotAllowedForRole message: nsk-server:Payment:ValidationError:PaymentMethodNotAllowedForRole type: Validation details: null rawMessage: Agent is not authorized for requested payment method KJ\AgencyAccount. 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. With Invalid Organization Code: description: The organization code in the request does not match the logged-in user's organization code. value: errors: - id: null code: nsk-server:Payment:ValidationError:AccountNumber message: nsk-server:Payment:ValidationError:AccountNumber type: Validation details: null rawMessage: 'Agency payment account number: (SYSTEM) does not match current Organization Code: 5876651' 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. '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Account Reference: description: The account reference does not match the logged-in user's organization code. value: errors: - id: null code: nsk:Payment:FundsNotAvailable message: nsk:Payment:FundsNotAvailable type: Error details: null rawMessage: Funds not available. The maximum expected amount is 0. 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. With Invalid Payment Method Type: description: The payment method type provided in the request is not of an agency account. value: errors: - id: null code: nsk:Payment:CreditFileNotConfigured message: nsk:Payment:CreditFileNotConfigured type: Validation details: null rawMessage: Credit file is not configured correctly. Verify the credit file in the settings.json file and also the payment method resources. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v2/booking/payments/organizationCredit: get: tags: - booking/payments summary: Gets credit available for the logged in users organization. description: 'Depending on configuration, credit may be validated by the contacts and passengers on the booking. GraphQL endpoint: paymentOrganizationCreditsv2' operationId: nsk_v2_booking_payments_organizationCredit_get parameters: - name: CurrencyCode in: query description: "The currency code of the account.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCreditAccount' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/refunds: get: tags: - booking/payments summary: Retrieves the booking payment methods available for a refund on the booking in state. description: 'Requires a booking in state. GraphQL endpoint: paymentRefundsAvailability' operationId: nsk_v1_booking_payments_refunds_get responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndPaymentMethod' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v5/booking/payments/refunds: post: tags: - booking/payments summary: Creates a refund for the booking in state. No longer handles Credit Shell or `CS` refunds. description: 'Requires a booking in state. NOTE: CS, credit shell refunds are no longer accepted through this endpoint. It is now recommended to use POST `api/nsk/v1/booking/payments/refunds/creditShell` endpoint for any credit shell refund. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentRefundsAddv5' operationId: nsk_v5_booking_payments_refunds_post requestBody: x-name: request description: The request for the refund. content: application/json: schema: $ref: '#/components/schemas/PaymentRefundRequestv2' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v4/booking/payments/refunds: post: tags: - booking/payments summary: Creates a refund for the booking in state. description: 'Requires a booking in state. Credit shell payment types will default to a customer credit if logged in. If not logged in a booking credit will be applied. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentRefundsAddv4' operationId: nsk_v4_booking_payments_refunds_post requestBody: x-name: request description: The payment reversal request. content: application/json: schema: $ref: '#/components/schemas/PaymentRefundRequest' required: true x-position: 1 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/payments/refunds/creditShell: post: tags: - booking/payments summary: Creates a credit shell refund for the booking in state. description: 'Requires a booking in state. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentRefundsCreditShell' operationId: nsk_v1_booking_payments_refunds_creditShell_post requestBody: x-name: request description: The credit shell refund request. content: application/json: schema: $ref: '#/components/schemas/CreditShellRefundRequest' required: true x-position: 1 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No Booking In State: description: Example of no booking in state. value: errors: - id: null code: nsk:Booking:NoBookingInState message: No booking was found in session, cannot perform operation. type: Error details: null 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 Invalid Credit Shell Account Type: description: Example of anonymous user attempting to create a customer credit. value: errors: - id: null code: nsk:Payment:InvalidCreditShellAccountType message: The payment credit shell account type CustomerNumber is not valid for the current user. type: Error details: null 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 Invalid Payment Method Code For Refund: description: Example of sending an empty or invalid refund request. value: errors: - id: null code: nsk:Payment:PaymentMethodCodeInvalidForRefund message: The payment method code CS is not allowed for refund. type: Error details: null 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 /api/nsk/v3/booking/payments/refunds/customerCredit: post: tags: - booking/payments summary: Creates a customer credit for a specified customer. description: 'Requires a booking in state and an agent token. Agents should use /refunds endpoint for booking credits. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentRefundsCustomerCreditv4' operationId: nsk_v3_booking_payments_refunds_customerCredit_post parameters: - name: skipBalanceValidation in: query description: Indicates whether the validation of the booking balance should be skipped. schema: type: boolean nullable: true x-position: 2 requestBody: x-name: request description: The customer credit refund request. content: application/json: schema: $ref: '#/components/schemas/CustomerCreditRefundRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/payments/refunds/organizationCredit: post: tags: - booking/payments summary: 'Creates an organization account refund for a payment from the booking in state.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: organizations2PaymentRefundAddv3' operationId: nsk_v3_booking_payments_refunds_organizationCredit_post requestBody: x-name: request description: The organization refund request. content: application/json: schema: $ref: '#/components/schemas/OrganizationRefundRequestv2' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/payments/refunds/organizationCredit: post: tags: - booking/payments summary: 'Creates an organization account refund for a payment from the booking in state.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: organizations2PaymentRefundAddv2' operationId: nsk_v2_booking_payments_refunds_organizationCredit_post requestBody: x-name: request description: The organization refund request. content: application/json: schema: $ref: '#/components/schemas/OrganizationRefundRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/payments/reversals: post: tags: - booking/payments summary: Reverses a payment for the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This endpoint works similarly with the refund endpoint (POST api/nsk/v4/booking/payments/refunds), but agent-only permissions are needed and does not require a zero or negative booking balance for processing. Requires a booking in state. Credit shell payment types will default to a customer credit if logged in. If not logged in a booking credit will be applied. GraphQL endpoint: paymentReversalsAdd' operationId: nsk_v1_booking_payments_reversals_post requestBody: x-name: request description: The payment reversal request. content: application/json: schema: $ref: '#/components/schemas/PaymentReversalRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/booking/payments/reversals: post: tags: - booking/payments summary: Reverses a payment for the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This endpoint works similarly with the refund endpoint (POST api/nsk/v4/booking/payments/refunds), but agent-only permissions are needed and does not require a zero or negative booking balance for processing. Requires a booking in state. NOTE: CS, credit shell refunds are no longer accepted through this endpoint. It is now recommended to use POST `api/nsk/v1/booking/payments/refunds/creditShell` endpoint for any credit shell refund. GraphQL endpoint: paymentReversalsAddv2' operationId: nsk_v2_booking_payments_reversals_post requestBody: x-name: request description: The payment reversal request. content: application/json: schema: $ref: '#/components/schemas/PaymentReversalRequestv2' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v7/booking/payments/storedPayment/{storedPaymentKey}: post: tags: - booking/payments summary: Creates a payment using the stored payment information for the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` Account Number and Expiration Date are stored. With stored payments, payment fields may still be required to complete the transaction. For example, a credit card that requires address information, this information is not stored with the stored payment. A 202 (HTTP status code) response returns alternate data signifying that either Three D Secure was enabled for this payment and is required for this payment type or a direct currency conversion (Dcc) offer was given. The payment will need to be resent using the 3DS endpoint or the Dcc endpoint. Note that it is possible for a payment to return a dcc offer and also have three d secure enabled. In these cases the direct currency conversion offer will need to be handled first and then the three d secure payment can be handled. If you would like to make a Dcc offer and the system using this endpoint cannot display a dcc offer to the end user, the status should be updated to DccNotOffered. This indicates that the offer was not displayed to the end user and is to be accepted automatically. If you would like to make a ThreeDSecure payment, you will need to provide a valid term url. You also need to have these headers populated: User Agent (USER-AGENT) Accept (ACCEPT) GraphQL endpoint: paymentAddStoredv7' operationId: nsk_v7_booking_payments_storedPayment_storedPaymentKey_post parameters: - name: storedPaymentKey in: path required: true description: Stored payment key. schema: type: string x-position: 1 - name: termUrl in: query description: The term url. schema: type: string nullable: true x-position: 3 requestBody: x-name: request description: Payment request. content: application/json: schema: $ref: '#/components/schemas/StoredPaymentRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentInformation' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Paying with a Blacklisted Card: description: Example response when attempting to pay with a blacklisted card without a reason. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is None. rawMessage: Blacklisted Card, the reason given is None. 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 Paying with a Lost Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as lost. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Lost. rawMessage: Blacklisted Card, the reason given is Lost. 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 Paying with a Stolen Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as stolen. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is Stolen. rawMessage: Blacklisted Card, the reason given is Stolen. 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 Paying with a Chargedback Blacklisted Card: description: Example response when attempting to pay with a blacklisted card tagged as chargedback. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk-server:Payment:ValidationError:BlackListedCard message: nsk-server:Payment:ValidationError:BlackListedCard type: Validation details: blacklistErrorMessage: Blacklisted Card, the reason given is ChargedBack. rawMessage: Blacklisted Card, the reason given is ChargedBack. 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 Inexistent or inactive payment method: description: Example response when the payment method is inexistent or inactive. Please see /resources/PaymentMethods for valid codes. value: errors: - id: null code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: '"The value ''DT'' is out of range for ''PaymentMethodRequest.PaymentMethodCode''.\nExpected values: (AC,AG,AP,AX,BD,BN,CA,CF,CK,DI,EA,EM,HP,IF,LP,LY,MC,OM,PP,PS,SO,SW,TA,TV,VI,VO)"' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v6/booking/payments/threeDSecure: post: tags: - booking/payments summary: Creates a new ThreeDSecure external payment or prepaid payment on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` A call to payments post should be made first and processed to verify a 3DS payment is required. If you would like to make a ThreeDSecure payment, you will need to provide a valid term url. You will also need to have these headers populated: User Agent (USER-AGENT) Accept (ACCEPT) GraphQL endpoint: paymentThreeDSecureAddv6' operationId: nsk_v6_booking_payments_threeDSecure_post parameters: - name: termUrl in: query description: The term URL. schema: type: string nullable: true x-position: 2 requestBody: x-name: request description: Payment request. content: application/json: schema: $ref: '#/components/schemas/ThreeDSecurePaymentMethodRequestv3' examples: Request: description: Example request for Three D Secure v6 POST. value: paRes: "eNrdWVmPq0iyfrfk/3DU8+jpZjM2jHxKShZjbBazL2/sBoNZbQy//qarzlLd94zUc19GuiVZBUlkZETGF/FFws68dEnCGUl075K3nZz0fZAlX/L462+CpfhiV5jGfVadC9GgXYX99rY7Az3p3wXer7ZjIrZmdEnY5O6PVHBezbeyvLHrY/8VSj+Srs/r2xv2B/oHvkO+38KFuugS3Ia3XRC1jKi8kSRJEMQO+Xa7q5JO5N7iJA3u5bBDPm53yM955/vrqodGP/P4Tcds1bmWU1DqZuw2ZxvP5ohjptDkv+6Ql8QuDobkDUfRLbrByS/Y+l8o9i+U2iHv47vmpQ5U9R3qJqDUDvk8soPb0yW3aHqj1vDRj7td8mzqWwIloHM/rnfIT+Oa4PaG/vlvC3XD0Z3pvu2GvPpsFP0yCoMC7+O7fgiGe//m7ZBvV7soeDzeCl6ywkxYmWmBAp0HrCzFbJCsarGHzr6L7JIof0NfRsH/77NAmdVdPlyqN+JD5ufADnmZgrzH821n5NkNLtYlX55VeYNRvAxD8y8EGcfxj5H4o+4yBBqMIiiNQIG4z7N//PYxK4nFW1r/R9PY4Fbf8igo8zkYIDLkZLjU8Zcftv1Kjam/NGGIzrO/Q1W/R9j69vtrBCUwEupEfq30k2d/Z5W/Gtv1we/9JXilAPIXRW87PUmTFyKSL5Yufv3tH38nNbg8S/rh/2LKdzM+a/iuzw7Ke/ImyU1cOzSOayTpHu8HU9kiGhsMegu+fp/3IblDftj+zbGPKH7arQ/BQBxS56GpB+Tp8b2CIrJfG+YcFkaFNxE7YV590R55gLsdq6D3Noifj9wxETKlzw/vAgQ+Pun0bbVcXAReO1ZOc7MJ7yzphiOwyngY7y2tNvE5UM4SYVVFuHFizprPq4gz4m16QW75BZ1984pF/iilStEtF6Q8D/kYwczvUcH2y6ZbcflYIhTj6ByzGWRiG3n9DR2NgyC3QnegaaZtZ5ohjFanMaZn16mr8OvlAvU3Bc81Y0E8754WJqsQG3zBolabYRALynkE60MjitsDiWLeo0L13A3W+gg1xTTltJRER47ZSOly4RgzQCzn6dQXqSUi4Sn1wDy6rWgX+Labi60yx3hM+WfNcp2cl+pNi8fj16+fUPUtMqdk+oiES6I0FwzBx5VxD4skGpQAVgj2q2X884thflUvef3PL9JXGdafuvvnF/UrG3RxfgtKtq5g8YTIZOuuqbv3hIDPrR8CXwALdbDKzwEuqeov71Dodshfl3y3gU26IU9hisHSKYviXuVYlmHZDIwiAzJRU32yYJ8zXiZUdj5tD7aKmOwMFCa7tpdrLtAjygCt3wOOoWStH1nN45YLW9MEfjza1syXMisLALN49iJHGr6ffKG8e86TC3EYGPdY+AbDhcRxhL9LLJSPsOAzmVm/z1ku2KfsWrhdxO6xiQ/XzHPIq8grj9Bl+sDZ3z3ceh45kDOZYjNANgVUuUSV3oTVvtdweggde4Iy2XJhuDBeTnn3J4bTTJDsR3SSC/4pc9EocwD+mOA1pnCvMW+SZ4tUzDKQReEk6+gojB4H/YLecYzOee7xGjjkJWQZ3newh7hXGh8ny6jgbZn55vE4yj89HjPNUkzZsEbxQ9Pppen5U9PLKwcro0opXx5GN+YRVXs0cOi7rFEjp73POnDAV3yHRENCfHImkF6eLxcwWDLD03XgUE8Yn+PHfngmKG0TxpURi7/GjN8DoLJAo8DrOZud4DUPlovxgUpbj02PM8FOveQKai5QZjAdrxPNb+0TXXRljnrSuBdH2dlPzHb0uQolZi+7RsrzXDpmYSvatFwckI10QgeQaa20CrU9RxBs2KCIMHbNWjSunt84cnF+sKvW6hWvvN8FXNtQdyEP2liCfNjZ8xha/nJB+xVaDebavwhdQT6ZM37RV8AgDs00WaAoNw4uNT2tiXW+OmatlRaJbAd42bjheSPK/XrI1mOfUstFsq82LUqCKfIn6TZsToRwDEor7iwzKXyH34oQRJLHHHMiucbRCNiLFpwfZ+7M1KnLsJxkrAHniMuFnjCASOWMJcfVJnpQm56Ei2JNBJiMILfIucEL3EbsrauEY8mwnqA+hlHkgAaYei0yjcmyIOBHiAIAI6ujJtAOCAPEEXBAfcXvoFEMSCke4pplAjAetHe5kmG8cQ888TR6DKNZB5irAsv2wnIBNGvPjBB/DPpCYMxlmsMwhhSHRHZywd4T47XeO8OxulzkR2DWJkjfV9J5XuCAk10+kL1c/BrbYM1kWcdk/J7RIoghrZfZejx9skUGgnAQLmh8ABtpoqF3AX4dQlyZI5aEOI8bD7enmCWLEEdH98OjlNl7o80xRr1nM7P25eCgoxFXPySC6QIDK6JqvC8XEVEOnmujwcfsh4fvU9/ZXxUuWntmRCozzKxCxBXTmrxCv6qmUiiChioFeHqm9jCFPeq7CrpcaNhRliplCrlv/hvyh/+M7jD8WNyngNCV7TEQD1KFrhua97pHAQYma7LLNWMuj8se6ADWAoahXnExPdEXgReudY3XYBRgLgk8LW1m8ekJryoDbZtl7iqwFSsYcI9WvMXwwOJPM2hA9sq7fa5fDJhTHnpRlOuTVN34IlcD6uHYPnbkOTzo0Flv9CwZCypxkjn0VROOp9oXL49IgdkrMdrLpiyDkNmzbXHK547W55ans/bhuipJDs30ZCK5V+LNZXNC2BFcrUt+7Q7VfR33PN0BXjjVHVbbFKEuF2pmae790LhuPxMJSQx2Xa0yZRW3l7NTl/6FWZeayh+esrVGt/g+3ugm9+RXQKqznOw6xaBc293n0DubUub7UEwgXHNyVNbSGN3Gc96bVqbper5e4wG+ngszwAWGZkMZzj8gq+uxovEWZY90j4hH7CrDDM4a1W+Pw7rdTh6kjbkRnVHUlUuL8KtDWyCkHiURyWMtLo39rOnTOkG2csX3J8ui9zdD3UoxaT6hd1PqS9E1OmZCcNIFvhIxqZQNE2xV7Np7VHad3FVKPnMGb6GyjiMYI25N/96/eq+/suev6JRPZ5jkePKDTuOiSWRF3If0pGCCTZmi6lPmL+mU/G/RqfitKLzTKf/v6NSq6EfMfqZSgMsz+Eyl8/tYcf1JpYfxf5HTcvGZEvnn3yREA5bD7H2OxD9j03cUDBaIqkQTg7mElZa9rIU9WwM9LHyTv8qs+L4H4CmH/2bfjhGhYHDl23IB12P+E9qcz5fWXJ0lIwAaE8tkUqM9ErUwhVzv3PfCbJjSwFc3ahCNGeEfh3QfoIbqKw8z2kjzzGelSEvdXJLyY8Sd/iBUxMO/i8+CmARuepDKcvHcpzcN6YqnApRCRRGewE7pXIyiV5yeNuXnZBz07CafidXqSlirg949zUNF1Rs0LZ99TEYlr6iMt1ycLcXLQPJ4jOhVlZmHjKQCiQnrQkCPEZOs8C7o+8ORo6LJIxx6Mz78EHn09xayaMggbG2yhy25gilEba5T8gTArmXMkCdh2xvC3pOn+92MZSFI8vOB9kPBD043tXPuViAi3U23E4WaV8BeV9ImO8JWv4B0WqyK6K6RQD1rW65uGerKK1bos9uusrTvtHlAZPFAycx7LGN+5Blk1EQZeC+ihJEAL8IZv5GKoEE6YLJ6v8lc0Q9+RSp/pZQQ96sQIgPi6bJcSL9sJu0/59f1lzJGiNOohvJ3jzj2EONg/UHIHxbzr3pwKUDznXwhzrKGWY8Hjg9kJvuOVF0XyltgKWV00zUDvQ5Q04RiCid/bwZU2Azw+73Hm6y6PXYxT/RlnUX30Mxv8GxzX8kM9b6yOGqeDLuIvZqF7CAQ8HxTr2m3ucduNzGZypR3JlFlgAqs0QqGGBKcxjPsaAEAmxWgsf35JAYyPqXycEy18OQdjqTUNNdyuQi92kNSecMipCMCAYuO27FcuUNCWudqP7ekvk+Ekc0ZYZVqGrBwZxPgmimRqIr33GaWJs8mxSNsz9IK5bvaISsxtUfynFbMkTOxKc3VOnxW915zzZHwusx6orKGCMfDlnHUiio3eZcyz5uzSQW1OGPOcmFWB+LZmtM1D5nLgULrxElvdK6PyJWDJxwPWHYQNSNeA/Mx8tJQEKVCFAZhYfoKbm5HZwaXI3qwXPhnXRk3k9Kp4dmhnMpq2QM6CGqPbDeb9VOjXPVM5cDqMpGYL1hRDk3th3FC7IWQSwfFatY3JTnBNpazRaIzOVt2989OVlP1zgT0vtb8znv8PULhNgUklOH0g1CkgCvwkXSIwy2L9koe3AjI+v8PCOUJyQSSh/VnQnkf0z4RyvW/RSiXb4n1SlPv3+zbexF4UQm06T8gk4kxx6o3j5h1SI+HJukU5rBZzY/7iQrhjs8PAQBRTIuHrk1HXkzIE1CTiykCbnpm+NPy2r2DmaDtVmsSaRhfOp/xPskszB9msbs2SArK+gC9w922tJxxNT6ku5DsT8NgDwZ3ExGRbK6MjF7T8wGLIiAVm8SkB3o/bu3Kt8nUj9q7dLMO/UlQzHa5wEBY8wM8hfsNN4OcQkl+Rjw5v20RIcJOp7RU9whBmRbdPOPsbN1Q2qnuYRJHojgY5PZyNbtjFsIe32zSTncFSHjhfRVOKXcCB/NaxzLrnMDIObI8PI9TTIQzZ1Itj5WsM1vPkrkqGrdRdeuUunWEx7AoYWfM4LUhnZ0yxenjGenZ1kK9S/39DIZDMuOA8VGC5feTFssB4XUKgx05871kw7T9VLSZAtx+FG0OJA0zjkLBw9LqfUfD2bQZyTBgS8Rpa8nkB9mUsdeJDJ7PfpzJzBqegvUBa9WzvQlv9oaC4Mv8MHOL4hfZ+44SHvR2yBdVTC4XNa6ft45/6AqrLW3F7xUCQSPmeR1rLu6RVUrL2emOTzzVbDy8b5hZxZWAyuPjkXOBmp+3DdYikQ2940aP6Az1ZGxMjW6xDMPI0guAPl9js9HCu8ElbWA1akbf+a1JYcfSm/kuugo9u5Jh971NQ755PJYLXOOTpPQL53RXrvA8ddyw802MTxK3qkQCPd+1uZjbh91Wx3tRB356OgkpUQ+c2IVXk6obA7c4soV40s8dL7vETQnm3H41EgXW+iVtuuvzVbk3FZex/dWd4PZayD7z6Nx1U3mWmHx6iC5O9vqQogMpwPbrJtjkyrHRrr+cA0y5WftupO064TsBJWeMotuWMui8ckaTWmtff9XXIz/f2iE/3uT9fMf3/i3j/WPL6/X7548w/wPGC01H\r\ \n" paReq: eNpdkk1TwjAQhu/5FQzjuWlSEIZZMgPiKAeBgQqOt5ju0Cr9IG35+vUmpRU1p302u8m+bwJ+qBEnK1SlRgEvmOdyi60oGLafXmfvU/3pr8rLfBN6matj1hawGC1xL+CAOo/SRDDHdTjQBok5QqtQJoUAqfbj6Ux0u13P84DWSCBGPZ0I1yyg15hAImMUM3mIChlpdFQaA61yBFRaJoU+i37H1DdAoNQ7ERZFlg8oPR6Pzr9mu02A3qZZlDbKjchTFIglW883X7uz3C394C1brPn2oibj84f/OARqKwgEskDBXe65jPEWdwe8P2BGSJUnIGM7i7jzuGOV1EggsxeNruRxu/U7Y/SUWmOiGkENEcBTliZoaoyfP7EZA3MlfMwLl5m7LRhdNzUPz9ZpVRgb71mv0+lVVldcHRkZtzi3vTWYbttD64ek9Zub6M9f+Ab9FK9z paymentTransactionKey: R1VOWklyalRTdXpPV2gzcDBybTEhMSEtMSEtMSEtMSFYWFhYWFhYWFhYWFgwMDA3 required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v7/booking/payments/threeDSecure: post: tags: - booking/payments summary: Creates a new ThreeDSecure external payment or prepaid payment on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` A call to payments post should be made first and processed to verify a 3DS payment is required. If you would like to make a ThreeDSecure payment, you will need to provide a valid term url. You will also need to have these headers populated: User Agent (USER-AGENT) Accept (ACCEPT) GraphQL endpoint: paymentThreeDSecureAddv6' operationId: nsk_v7_booking_payments_threeDSecure_post parameters: - name: termUrl in: query description: The term URL. schema: type: string nullable: true x-position: 2 requestBody: x-name: request description: Payment request. content: application/json: schema: $ref: '#/components/schemas/ThreeDSecurePaymentMethodRequestv3' examples: Request: description: Example request for Three D Secure v6 POST. value: paRes: "eNrdWVmPq0iyfrfk/3DU8+jpZjM2jHxKShZjbBazL2/sBoNZbQy//qarzlLd94zUc19GuiVZBUlkZETGF/FFws68dEnCGUl075K3nZz0fZAlX/L462+CpfhiV5jGfVadC9GgXYX99rY7Az3p3wXer7ZjIrZmdEnY5O6PVHBezbeyvLHrY/8VSj+Srs/r2xv2B/oHvkO+38KFuugS3Ia3XRC1jKi8kSRJEMQO+Xa7q5JO5N7iJA3u5bBDPm53yM955/vrqodGP/P4Tcds1bmWU1DqZuw2ZxvP5ohjptDkv+6Ql8QuDobkDUfRLbrByS/Y+l8o9i+U2iHv47vmpQ5U9R3qJqDUDvk8soPb0yW3aHqj1vDRj7td8mzqWwIloHM/rnfIT+Oa4PaG/vlvC3XD0Z3pvu2GvPpsFP0yCoMC7+O7fgiGe//m7ZBvV7soeDzeCl6ywkxYmWmBAp0HrCzFbJCsarGHzr6L7JIof0NfRsH/77NAmdVdPlyqN+JD5ufADnmZgrzH821n5NkNLtYlX55VeYNRvAxD8y8EGcfxj5H4o+4yBBqMIiiNQIG4z7N//PYxK4nFW1r/R9PY4Fbf8igo8zkYIDLkZLjU8Zcftv1Kjam/NGGIzrO/Q1W/R9j69vtrBCUwEupEfq30k2d/Z5W/Gtv1we/9JXilAPIXRW87PUmTFyKSL5Yufv3tH38nNbg8S/rh/2LKdzM+a/iuzw7Ke/ImyU1cOzSOayTpHu8HU9kiGhsMegu+fp/3IblDftj+zbGPKH7arQ/BQBxS56GpB+Tp8b2CIrJfG+YcFkaFNxE7YV590R55gLsdq6D3Noifj9wxETKlzw/vAgQ+Pun0bbVcXAReO1ZOc7MJ7yzphiOwyngY7y2tNvE5UM4SYVVFuHFizprPq4gz4m16QW75BZ1984pF/iilStEtF6Q8D/kYwczvUcH2y6ZbcflYIhTj6ByzGWRiG3n9DR2NgyC3QnegaaZtZ5ohjFanMaZn16mr8OvlAvU3Bc81Y0E8754WJqsQG3zBolabYRALynkE60MjitsDiWLeo0L13A3W+gg1xTTltJRER47ZSOly4RgzQCzn6dQXqSUi4Sn1wDy6rWgX+Labi60yx3hM+WfNcp2cl+pNi8fj16+fUPUtMqdk+oiES6I0FwzBx5VxD4skGpQAVgj2q2X884thflUvef3PL9JXGdafuvvnF/UrG3RxfgtKtq5g8YTIZOuuqbv3hIDPrR8CXwALdbDKzwEuqeov71Dodshfl3y3gU26IU9hisHSKYviXuVYlmHZDIwiAzJRU32yYJ8zXiZUdj5tD7aKmOwMFCa7tpdrLtAjygCt3wOOoWStH1nN45YLW9MEfjza1syXMisLALN49iJHGr6ffKG8e86TC3EYGPdY+AbDhcRxhL9LLJSPsOAzmVm/z1ku2KfsWrhdxO6xiQ/XzHPIq8grj9Bl+sDZ3z3ceh45kDOZYjNANgVUuUSV3oTVvtdweggde4Iy2XJhuDBeTnn3J4bTTJDsR3SSC/4pc9EocwD+mOA1pnCvMW+SZ4tUzDKQReEk6+gojB4H/YLecYzOee7xGjjkJWQZ3newh7hXGh8ny6jgbZn55vE4yj89HjPNUkzZsEbxQ9Pppen5U9PLKwcro0opXx5GN+YRVXs0cOi7rFEjp73POnDAV3yHRENCfHImkF6eLxcwWDLD03XgUE8Yn+PHfngmKG0TxpURi7/GjN8DoLJAo8DrOZud4DUPlovxgUpbj02PM8FOveQKai5QZjAdrxPNb+0TXXRljnrSuBdH2dlPzHb0uQolZi+7RsrzXDpmYSvatFwckI10QgeQaa20CrU9RxBs2KCIMHbNWjSunt84cnF+sKvW6hWvvN8FXNtQdyEP2liCfNjZ8xha/nJB+xVaDebavwhdQT6ZM37RV8AgDs00WaAoNw4uNT2tiXW+OmatlRaJbAd42bjheSPK/XrI1mOfUstFsq82LUqCKfIn6TZsToRwDEor7iwzKXyH34oQRJLHHHMiucbRCNiLFpwfZ+7M1KnLsJxkrAHniMuFnjCASOWMJcfVJnpQm56Ei2JNBJiMILfIucEL3EbsrauEY8mwnqA+hlHkgAaYei0yjcmyIOBHiAIAI6ujJtAOCAPEEXBAfcXvoFEMSCke4pplAjAetHe5kmG8cQ888TR6DKNZB5irAsv2wnIBNGvPjBB/DPpCYMxlmsMwhhSHRHZywd4T47XeO8OxulzkR2DWJkjfV9J5XuCAk10+kL1c/BrbYM1kWcdk/J7RIoghrZfZejx9skUGgnAQLmh8ABtpoqF3AX4dQlyZI5aEOI8bD7enmCWLEEdH98OjlNl7o80xRr1nM7P25eCgoxFXPySC6QIDK6JqvC8XEVEOnmujwcfsh4fvU9/ZXxUuWntmRCozzKxCxBXTmrxCv6qmUiiChioFeHqm9jCFPeq7CrpcaNhRliplCrlv/hvyh/+M7jD8WNyngNCV7TEQD1KFrhua97pHAQYma7LLNWMuj8se6ADWAoahXnExPdEXgReudY3XYBRgLgk8LW1m8ekJryoDbZtl7iqwFSsYcI9WvMXwwOJPM2hA9sq7fa5fDJhTHnpRlOuTVN34IlcD6uHYPnbkOTzo0Flv9CwZCypxkjn0VROOp9oXL49IgdkrMdrLpiyDkNmzbXHK547W55ans/bhuipJDs30ZCK5V+LNZXNC2BFcrUt+7Q7VfR33PN0BXjjVHVbbFKEuF2pmae790LhuPxMJSQx2Xa0yZRW3l7NTl/6FWZeayh+esrVGt/g+3ugm9+RXQKqznOw6xaBc293n0DubUub7UEwgXHNyVNbSGN3Gc96bVqbper5e4wG+ngszwAWGZkMZzj8gq+uxovEWZY90j4hH7CrDDM4a1W+Pw7rdTh6kjbkRnVHUlUuL8KtDWyCkHiURyWMtLo39rOnTOkG2csX3J8ui9zdD3UoxaT6hd1PqS9E1OmZCcNIFvhIxqZQNE2xV7Np7VHad3FVKPnMGb6GyjiMYI25N/96/eq+/suev6JRPZ5jkePKDTuOiSWRF3If0pGCCTZmi6lPmL+mU/G/RqfitKLzTKf/v6NSq6EfMfqZSgMsz+Eyl8/tYcf1JpYfxf5HTcvGZEvnn3yREA5bD7H2OxD9j03cUDBaIqkQTg7mElZa9rIU9WwM9LHyTv8qs+L4H4CmH/2bfjhGhYHDl23IB12P+E9qcz5fWXJ0lIwAaE8tkUqM9ErUwhVzv3PfCbJjSwFc3ahCNGeEfh3QfoIbqKw8z2kjzzGelSEvdXJLyY8Sd/iBUxMO/i8+CmARuepDKcvHcpzcN6YqnApRCRRGewE7pXIyiV5yeNuXnZBz07CafidXqSlirg949zUNF1Rs0LZ99TEYlr6iMt1ycLcXLQPJ4jOhVlZmHjKQCiQnrQkCPEZOs8C7o+8ORo6LJIxx6Mz78EHn09xayaMggbG2yhy25gilEba5T8gTArmXMkCdh2xvC3pOn+92MZSFI8vOB9kPBD043tXPuViAi3U23E4WaV8BeV9ImO8JWv4B0WqyK6K6RQD1rW65uGerKK1bos9uusrTvtHlAZPFAycx7LGN+5Blk1EQZeC+ihJEAL8IZv5GKoEE6YLJ6v8lc0Q9+RSp/pZQQ96sQIgPi6bJcSL9sJu0/59f1lzJGiNOohvJ3jzj2EONg/UHIHxbzr3pwKUDznXwhzrKGWY8Hjg9kJvuOVF0XyltgKWV00zUDvQ5Q04RiCid/bwZU2Azw+73Hm6y6PXYxT/RlnUX30Mxv8GxzX8kM9b6yOGqeDLuIvZqF7CAQ8HxTr2m3ucduNzGZypR3JlFlgAqs0QqGGBKcxjPsaAEAmxWgsf35JAYyPqXycEy18OQdjqTUNNdyuQi92kNSecMipCMCAYuO27FcuUNCWudqP7ekvk+Ekc0ZYZVqGrBwZxPgmimRqIr33GaWJs8mxSNsz9IK5bvaISsxtUfynFbMkTOxKc3VOnxW915zzZHwusx6orKGCMfDlnHUiio3eZcyz5uzSQW1OGPOcmFWB+LZmtM1D5nLgULrxElvdK6PyJWDJxwPWHYQNSNeA/Mx8tJQEKVCFAZhYfoKbm5HZwaXI3qwXPhnXRk3k9Kp4dmhnMpq2QM6CGqPbDeb9VOjXPVM5cDqMpGYL1hRDk3th3FC7IWQSwfFatY3JTnBNpazRaIzOVt2989OVlP1zgT0vtb8znv8PULhNgUklOH0g1CkgCvwkXSIwy2L9koe3AjI+v8PCOUJyQSSh/VnQnkf0z4RyvW/RSiXb4n1SlPv3+zbexF4UQm06T8gk4kxx6o3j5h1SI+HJukU5rBZzY/7iQrhjs8PAQBRTIuHrk1HXkzIE1CTiykCbnpm+NPy2r2DmaDtVmsSaRhfOp/xPskszB9msbs2SArK+gC9w922tJxxNT6ku5DsT8NgDwZ3ExGRbK6MjF7T8wGLIiAVm8SkB3o/bu3Kt8nUj9q7dLMO/UlQzHa5wEBY8wM8hfsNN4OcQkl+Rjw5v20RIcJOp7RU9whBmRbdPOPsbN1Q2qnuYRJHojgY5PZyNbtjFsIe32zSTncFSHjhfRVOKXcCB/NaxzLrnMDIObI8PI9TTIQzZ1Itj5WsM1vPkrkqGrdRdeuUunWEx7AoYWfM4LUhnZ0yxenjGenZ1kK9S/39DIZDMuOA8VGC5feTFssB4XUKgx05871kw7T9VLSZAtx+FG0OJA0zjkLBw9LqfUfD2bQZyTBgS8Rpa8nkB9mUsdeJDJ7PfpzJzBqegvUBa9WzvQlv9oaC4Mv8MHOL4hfZ+44SHvR2yBdVTC4XNa6ft45/6AqrLW3F7xUCQSPmeR1rLu6RVUrL2emOTzzVbDy8b5hZxZWAyuPjkXOBmp+3DdYikQ2940aP6Az1ZGxMjW6xDMPI0guAPl9js9HCu8ElbWA1akbf+a1JYcfSm/kuugo9u5Jh971NQ755PJYLXOOTpPQL53RXrvA8ddyw802MTxK3qkQCPd+1uZjbh91Wx3tRB356OgkpUQ+c2IVXk6obA7c4soV40s8dL7vETQnm3H41EgXW+iVtuuvzVbk3FZex/dWd4PZayD7z6Nx1U3mWmHx6iC5O9vqQogMpwPbrJtjkyrHRrr+cA0y5WftupO064TsBJWeMotuWMui8ckaTWmtff9XXIz/f2iE/3uT9fMf3/i3j/WPL6/X7548w/wPGC01H\r\ \n" paReq: eNpdkk1TwjAQhu/5FQzjuWlSEIZZMgPiKAeBgQqOt5ju0Cr9IG35+vUmpRU1p302u8m+bwJ+qBEnK1SlRgEvmOdyi60oGLafXmfvU/3pr8rLfBN6matj1hawGC1xL+CAOo/SRDDHdTjQBok5QqtQJoUAqfbj6Ux0u13P84DWSCBGPZ0I1yyg15hAImMUM3mIChlpdFQaA61yBFRaJoU+i37H1DdAoNQ7ERZFlg8oPR6Pzr9mu02A3qZZlDbKjchTFIglW883X7uz3C394C1brPn2oibj84f/OARqKwgEskDBXe65jPEWdwe8P2BGSJUnIGM7i7jzuGOV1EggsxeNruRxu/U7Y/SUWmOiGkENEcBTliZoaoyfP7EZA3MlfMwLl5m7LRhdNzUPz9ZpVRgb71mv0+lVVldcHRkZtzi3vTWYbttD64ek9Zub6M9f+Ab9FK9z paymentTransactionKey: R1VOWklyalRTdXpPV2gzcDBybTEhMSEtMSEtMSEtMSFYWFhYWFhYWFhYWFgwMDA3 required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPayment' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/payments/threeDSecureRedirect: post: tags: - booking/payments summary: Creates a new ThreeDSecure Redirect external payment or prepaid payment on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` A call to payments post should be made first and processed to verify a 3DS payment is required. If you would like to make a ThreeDSecure Redirect payment, you will need to provide a valid term url. You will also need to have these headers populated: User Agent (USER-AGENT) Accept (ACCEPT) GraphQL endpoint: paymentThreeDSecureRedirectAdd' operationId: nsk_v1_booking_payments_threeDSecureRedirect_post parameters: - name: termUrl in: query description: The term URL. schema: type: string nullable: true x-position: 2 requestBody: x-name: request description: Payment request. content: application/json: schema: $ref: '#/components/schemas/ThreeDSecurePaymentMethodRequestv3' examples: Request: description: Example request for Three D Secure Redirect POST. value: paRes: "eNrdWVmPq0iyfrfk/3DU8+jpZjM2jHxKShZjbBazL2/sBoNZbQy//qarzlLd94zUc19GuiVZBUlkZETGF/FFws68dEnCGUl075K3nZz0fZAlX/L462+CpfhiV5jGfVadC9GgXYX99rY7Az3p3wXer7ZjIrZmdEnY5O6PVHBezbeyvLHrY/8VSj+Srs/r2xv2B/oHvkO+38KFuugS3Ia3XRC1jKi8kSRJEMQO+Xa7q5JO5N7iJA3u5bBDPm53yM955/vrqodGP/P4Tcds1bmWU1DqZuw2ZxvP5ohjptDkv+6Ql8QuDobkDUfRLbrByS/Y+l8o9i+U2iHv47vmpQ5U9R3qJqDUDvk8soPb0yW3aHqj1vDRj7td8mzqWwIloHM/rnfIT+Oa4PaG/vlvC3XD0Z3pvu2GvPpsFP0yCoMC7+O7fgiGe//m7ZBvV7soeDzeCl6ywkxYmWmBAp0HrCzFbJCsarGHzr6L7JIof0NfRsH/77NAmdVdPlyqN+JD5ufADnmZgrzH821n5NkNLtYlX55VeYNRvAxD8y8EGcfxj5H4o+4yBBqMIiiNQIG4z7N//PYxK4nFW1r/R9PY4Fbf8igo8zkYIDLkZLjU8Zcftv1Kjam/NGGIzrO/Q1W/R9j69vtrBCUwEupEfq30k2d/Z5W/Gtv1we/9JXilAPIXRW87PUmTFyKSL5Yufv3tH38nNbg8S/rh/2LKdzM+a/iuzw7Ke/ImyU1cOzSOayTpHu8HU9kiGhsMegu+fp/3IblDftj+zbGPKH7arQ/BQBxS56GpB+Tp8b2CIrJfG+YcFkaFNxE7YV590R55gLsdq6D3Noifj9wxETKlzw/vAgQ+Pun0bbVcXAReO1ZOc7MJ7yzphiOwyngY7y2tNvE5UM4SYVVFuHFizprPq4gz4m16QW75BZ1984pF/iilStEtF6Q8D/kYwczvUcH2y6ZbcflYIhTj6ByzGWRiG3n9DR2NgyC3QnegaaZtZ5ohjFanMaZn16mr8OvlAvU3Bc81Y0E8754WJqsQG3zBolabYRALynkE60MjitsDiWLeo0L13A3W+gg1xTTltJRER47ZSOly4RgzQCzn6dQXqSUi4Sn1wDy6rWgX+Labi60yx3hM+WfNcp2cl+pNi8fj16+fUPUtMqdk+oiES6I0FwzBx5VxD4skGpQAVgj2q2X884thflUvef3PL9JXGdafuvvnF/UrG3RxfgtKtq5g8YTIZOuuqbv3hIDPrR8CXwALdbDKzwEuqeov71Dodshfl3y3gU26IU9hisHSKYviXuVYlmHZDIwiAzJRU32yYJ8zXiZUdj5tD7aKmOwMFCa7tpdrLtAjygCt3wOOoWStH1nN45YLW9MEfjza1syXMisLALN49iJHGr6ffKG8e86TC3EYGPdY+AbDhcRxhL9LLJSPsOAzmVm/z1ku2KfsWrhdxO6xiQ/XzHPIq8grj9Bl+sDZ3z3ceh45kDOZYjNANgVUuUSV3oTVvtdweggde4Iy2XJhuDBeTnn3J4bTTJDsR3SSC/4pc9EocwD+mOA1pnCvMW+SZ4tUzDKQReEk6+gojB4H/YLecYzOee7xGjjkJWQZ3newh7hXGh8ny6jgbZn55vE4yj89HjPNUkzZsEbxQ9Pppen5U9PLKwcro0opXx5GN+YRVXs0cOi7rFEjp73POnDAV3yHRENCfHImkF6eLxcwWDLD03XgUE8Yn+PHfngmKG0TxpURi7/GjN8DoLJAo8DrOZud4DUPlovxgUpbj02PM8FOveQKai5QZjAdrxPNb+0TXXRljnrSuBdH2dlPzHb0uQolZi+7RsrzXDpmYSvatFwckI10QgeQaa20CrU9RxBs2KCIMHbNWjSunt84cnF+sKvW6hWvvN8FXNtQdyEP2liCfNjZ8xha/nJB+xVaDebavwhdQT6ZM37RV8AgDs00WaAoNw4uNT2tiXW+OmatlRaJbAd42bjheSPK/XrI1mOfUstFsq82LUqCKfIn6TZsToRwDEor7iwzKXyH34oQRJLHHHMiucbRCNiLFpwfZ+7M1KnLsJxkrAHniMuFnjCASOWMJcfVJnpQm56Ei2JNBJiMILfIucEL3EbsrauEY8mwnqA+hlHkgAaYei0yjcmyIOBHiAIAI6ujJtAOCAPEEXBAfcXvoFEMSCke4pplAjAetHe5kmG8cQ888TR6DKNZB5irAsv2wnIBNGvPjBB/DPpCYMxlmsMwhhSHRHZywd4T47XeO8OxulzkR2DWJkjfV9J5XuCAk10+kL1c/BrbYM1kWcdk/J7RIoghrZfZejx9skUGgnAQLmh8ABtpoqF3AX4dQlyZI5aEOI8bD7enmCWLEEdH98OjlNl7o80xRr1nM7P25eCgoxFXPySC6QIDK6JqvC8XEVEOnmujwcfsh4fvU9/ZXxUuWntmRCozzKxCxBXTmrxCv6qmUiiChioFeHqm9jCFPeq7CrpcaNhRliplCrlv/hvyh/+M7jD8WNyngNCV7TEQD1KFrhua97pHAQYma7LLNWMuj8se6ADWAoahXnExPdEXgReudY3XYBRgLgk8LW1m8ekJryoDbZtl7iqwFSsYcI9WvMXwwOJPM2hA9sq7fa5fDJhTHnpRlOuTVN34IlcD6uHYPnbkOTzo0Flv9CwZCypxkjn0VROOp9oXL49IgdkrMdrLpiyDkNmzbXHK547W55ans/bhuipJDs30ZCK5V+LNZXNC2BFcrUt+7Q7VfR33PN0BXjjVHVbbFKEuF2pmae790LhuPxMJSQx2Xa0yZRW3l7NTl/6FWZeayh+esrVGt/g+3ugm9+RXQKqznOw6xaBc293n0DubUub7UEwgXHNyVNbSGN3Gc96bVqbper5e4wG+ngszwAWGZkMZzj8gq+uxovEWZY90j4hH7CrDDM4a1W+Pw7rdTh6kjbkRnVHUlUuL8KtDWyCkHiURyWMtLo39rOnTOkG2csX3J8ui9zdD3UoxaT6hd1PqS9E1OmZCcNIFvhIxqZQNE2xV7Np7VHad3FVKPnMGb6GyjiMYI25N/96/eq+/suev6JRPZ5jkePKDTuOiSWRF3If0pGCCTZmi6lPmL+mU/G/RqfitKLzTKf/v6NSq6EfMfqZSgMsz+Eyl8/tYcf1JpYfxf5HTcvGZEvnn3yREA5bD7H2OxD9j03cUDBaIqkQTg7mElZa9rIU9WwM9LHyTv8qs+L4H4CmH/2bfjhGhYHDl23IB12P+E9qcz5fWXJ0lIwAaE8tkUqM9ErUwhVzv3PfCbJjSwFc3ahCNGeEfh3QfoIbqKw8z2kjzzGelSEvdXJLyY8Sd/iBUxMO/i8+CmARuepDKcvHcpzcN6YqnApRCRRGewE7pXIyiV5yeNuXnZBz07CafidXqSlirg949zUNF1Rs0LZ99TEYlr6iMt1ycLcXLQPJ4jOhVlZmHjKQCiQnrQkCPEZOs8C7o+8ORo6LJIxx6Mz78EHn09xayaMggbG2yhy25gilEba5T8gTArmXMkCdh2xvC3pOn+92MZSFI8vOB9kPBD043tXPuViAi3U23E4WaV8BeV9ImO8JWv4B0WqyK6K6RQD1rW65uGerKK1bos9uusrTvtHlAZPFAycx7LGN+5Blk1EQZeC+ihJEAL8IZv5GKoEE6YLJ6v8lc0Q9+RSp/pZQQ96sQIgPi6bJcSL9sJu0/59f1lzJGiNOohvJ3jzj2EONg/UHIHxbzr3pwKUDznXwhzrKGWY8Hjg9kJvuOVF0XyltgKWV00zUDvQ5Q04RiCid/bwZU2Azw+73Hm6y6PXYxT/RlnUX30Mxv8GxzX8kM9b6yOGqeDLuIvZqF7CAQ8HxTr2m3ucduNzGZypR3JlFlgAqs0QqGGBKcxjPsaAEAmxWgsf35JAYyPqXycEy18OQdjqTUNNdyuQi92kNSecMipCMCAYuO27FcuUNCWudqP7ekvk+Ekc0ZYZVqGrBwZxPgmimRqIr33GaWJs8mxSNsz9IK5bvaISsxtUfynFbMkTOxKc3VOnxW915zzZHwusx6orKGCMfDlnHUiio3eZcyz5uzSQW1OGPOcmFWB+LZmtM1D5nLgULrxElvdK6PyJWDJxwPWHYQNSNeA/Mx8tJQEKVCFAZhYfoKbm5HZwaXI3qwXPhnXRk3k9Kp4dmhnMpq2QM6CGqPbDeb9VOjXPVM5cDqMpGYL1hRDk3th3FC7IWQSwfFatY3JTnBNpazRaIzOVt2989OVlP1zgT0vtb8znv8PULhNgUklOH0g1CkgCvwkXSIwy2L9koe3AjI+v8PCOUJyQSSh/VnQnkf0z4RyvW/RSiXb4n1SlPv3+zbexF4UQm06T8gk4kxx6o3j5h1SI+HJukU5rBZzY/7iQrhjs8PAQBRTIuHrk1HXkzIE1CTiykCbnpm+NPy2r2DmaDtVmsSaRhfOp/xPskszB9msbs2SArK+gC9w922tJxxNT6ku5DsT8NgDwZ3ExGRbK6MjF7T8wGLIiAVm8SkB3o/bu3Kt8nUj9q7dLMO/UlQzHa5wEBY8wM8hfsNN4OcQkl+Rjw5v20RIcJOp7RU9whBmRbdPOPsbN1Q2qnuYRJHojgY5PZyNbtjFsIe32zSTncFSHjhfRVOKXcCB/NaxzLrnMDIObI8PI9TTIQzZ1Itj5WsM1vPkrkqGrdRdeuUunWEx7AoYWfM4LUhnZ0yxenjGenZ1kK9S/39DIZDMuOA8VGC5feTFssB4XUKgx05871kw7T9VLSZAtx+FG0OJA0zjkLBw9LqfUfD2bQZyTBgS8Rpa8nkB9mUsdeJDJ7PfpzJzBqegvUBa9WzvQlv9oaC4Mv8MHOL4hfZ+44SHvR2yBdVTC4XNa6ft45/6AqrLW3F7xUCQSPmeR1rLu6RVUrL2emOTzzVbDy8b5hZxZWAyuPjkXOBmp+3DdYikQ2940aP6Az1ZGxMjW6xDMPI0guAPl9js9HCu8ElbWA1akbf+a1JYcfSm/kuugo9u5Jh971NQ755PJYLXOOTpPQL53RXrvA8ddyw802MTxK3qkQCPd+1uZjbh91Wx3tRB356OgkpUQ+c2IVXk6obA7c4soV40s8dL7vETQnm3H41EgXW+iVtuuvzVbk3FZex/dWd4PZayD7z6Nx1U3mWmHx6iC5O9vqQogMpwPbrJtjkyrHRrr+cA0y5WftupO064TsBJWeMotuWMui8ckaTWmtff9XXIz/f2iE/3uT9fMf3/i3j/WPL6/X7548w/wPGC01H\r\ \n" paReq: eNpdkk1TwjAQhu/5FQzjuWlSEIZZMgPiKAeBgQqOt5ju0Cr9IG35+vUmpRU1p302u8m+bwJ+qBEnK1SlRgEvmOdyi60oGLafXmfvU/3pr8rLfBN6matj1hawGC1xL+CAOo/SRDDHdTjQBok5QqtQJoUAqfbj6Ux0u13P84DWSCBGPZ0I1yyg15hAImMUM3mIChlpdFQaA61yBFRaJoU+i37H1DdAoNQ7ERZFlg8oPR6Pzr9mu02A3qZZlDbKjchTFIglW883X7uz3C394C1brPn2oibj84f/OARqKwgEskDBXe65jPEWdwe8P2BGSJUnIGM7i7jzuGOV1EggsxeNruRxu/U7Y/SUWmOiGkENEcBTliZoaoyfP7EZA3MlfMwLl5m7LRhdNzUPz9ZpVRgb71mv0+lVVldcHRkZtzi3vTWYbttD64ek9Zub6M9f+Ab9FK9z paymentTransactionKey: R1VOWklyalRTdXpPV2gzcDBybTEhMSEtMSEtMSEtMSFYWFhYWFhYWFhYWFgwMDA3 required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPayment' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v4/booking/payments/voucher: post: tags: - booking/payments summary: Creates a new voucher payment on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: paymentVouchersAddv4' operationId: nsk_v4_booking_payments_voucher_post requestBody: x-name: request description: The request for payment with a voucher. content: application/json: schema: $ref: '#/components/schemas/VoucherPaymentRequest' required: true x-position: 1 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid payment method code: description: 'Example response when the payment method code is invalid. Invalid can mean the following: inactive, non-existent, payment method type is not voucher, unallowed for the role, or unallowed for the request currency code. Please see /resources/PaymentMethods for valid codes.' value: errors: - id: null code: nsk:Payment:FieldInvalid message: nsk:Payment:FieldInvalid type: Validation details: null rawMessage: The payment field VO is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v3/booking/payments/voucher: get: tags: - booking/payments summary: 'Gets information regarding a specific voucher code and validates whether the referenced voucher exists as a voucher payment in the booking in state.' description: 'GraphQL endpoint: paymentVouchersv3' operationId: nsk_v3_booking_payments_voucher_get parameters: - name: ReferenceCode in: query description: "The voucher reference code.\n " schema: type: string maxLength: 20 minLength: 1 nullable: true x-position: 1 - name: OverrideRestrictions in: query description: "Override restrictions. Defaults to false.\n " schema: type: boolean nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherInformation' examples: Valid Voucher Requested: description: Example Voucher Returned value: data: calculatedAmount: 7.0 customerNumber: null foreignCalculatedAmount: 0.0 foreignCalculatededCurrencyCode: null foreignReversableAmount: 0.0 nameRestriction: 0 redeemableAmount: 7.0 reversableAmount: 0.0 foreignAvailableCurrencyCode: '' availableAmount: 1000.0 foreignCurrencyCode: null foreignAmount: 1000.0 type: 1 password: null recordLocator: null transactions: null voucherKey: voucherKey reference: voucherReferenceNumber configurationCode: VOUCH status: 0 available: 1000.0 firstName: null lastName: null personKey: null voucherIssuanceKey: voucherIssuanceKey expiration: null currencyCode: USD amount: 1000.0 All Fields Filled Voucher Response: description: Example Voucher Returned value: data: calculatedAmount: 124.0 customerNumber: customerNumber foreignCalculatedAmount: 0.0 foreignCalculatededCurrencyCode: '' foreignReversableAmount: 0.0 nameRestriction: 2 redeemableAmount: 0.0 reversableAmount: 0.0 foreignAvailableCurrencyCode: '' availableAmount: 0.0 foreignCurrencyCode: '' foreignAmount: 0.0 type: 0 password: NOTSUPPORTED recordLocator: XXXXXX transactions: - voucherTransactionKey: voucherTransactionKey type: 1 recordLocator: XXXXXX foreignCurrencyCode: '' foreignAmount: 0.0 currencyCode: USD amount: 100.0 - voucherTransactionKey: voucherTransactionKey1 type: 0 recordLocator: XXXXXX foreignCurrencyCode: '' foreignAmount: 0.0 currencyCode: USD amount: 100.0 voucherKey: voucherKey reference: voucherReferenceNumber configurationCode: VOUCH status: 2 available: 0.0 firstName: firstName lastName: lastName personKey: personKey voucherIssuanceKey: voucherIssuanceKey expiration: '2026-07-10T00:00:00+00:00' currencyCode: USD amount: 100.0 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Voucher Calculated Amount is 0: description: Example error if a voucher has a calculated amount of 0, or doesn't belong to the requester. value: errors: - id: null code: nsk:Voucher:VoucherUnavailable message: "Requested Voucher has no Redeemable Balance. This\ \ can be due to any number of reasons including Balance already\ \ used, Balance already applied, Voucher doesn\u2019t apply\ \ to Booking, Restriction on Voucher, Voucher doesn\u2019\ t belong to Requested User, etc." type: Error details: null 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. messages: - code: nsk:Voucher:VoucherValidationWarning type: VoucherValidation value: nsk:Voucher:VoucherValidationWarning status: 0 details: voucherWarningMessage: 'Journey: NV5610 Sat, 18Nov SLC-BOS 19:00-23:59 did not match any of the voucher market restrictions.' data: null Voucher Reference Not Supplied: description: Example error if no Voucher Reference is included on the request. value: errors: - id: null code: VoucherRequest.ReferenceCode:RequiredAttribute message: The VoucherRequest field is required. type: Validation details: validation: RequiredAttribute model: VoucherRequest member: ReferenceCode 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 '403': description: There was a problem authorizing the request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/payments/voucher/{voucherPaymentReference}: delete: tags: - booking/payments summary: Reverses a voucher payment on the booking in state. This refunds the claimed amount on the voucher. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: paymentVoucherDeletev2' operationId: nsk_v2_booking_payments_voucher_voucherPaymentReference_delete parameters: - name: voucherPaymentReference in: path required: true description: Voucher payment reference. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/payments/voucher/passenger/{passengerKey}: post: tags: - booking/payments summary: Creates a new voucher payment for a specified passenger. description: 'For a passenger-select voucher to be shared across passengers, please use the standard voucher payment endpoint. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentPassengerVouchersAdd' operationId: nsk_v1_booking_payments_voucher_passenger_passengerKey_post parameters: - name: passengerKey in: path required: true description: Passenger key. schema: type: string x-position: 1 requestBody: x-name: request description: Passenger voucher payment request. content: application/json: schema: $ref: '#/components/schemas/VoucherPaymentRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentInformation' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid payment method code: description: 'Example response when the payment method code is invalid. Invalid can mean the following: inactive, non-existent, payment method type is not voucher, unallowed for the role, or unallowed for the request currency code. Please see /resources/PaymentMethods for valid codes.' value: errors: - id: null code: nsk:Payment:FieldInvalid message: nsk:Payment:FieldInvalid type: Error details: null rawMessage: The payment field VO is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/booking/payments/voucher/reassess: put: tags: - booking/payments summary: 'Reassess the voucher payments on the current booking in state. This will reverse non-adjustable voucher payments to balance the voucher when the booking is overpaid. The use of the voucher is not considered in the reassessment of a non-adjustable voucher payment. Multi-use without adjustment vouchers will be prioritized over single-use without adjustment vouchers. Vouchers with a longer expiration date will also be prioritized. The voucher type will be honored first and then the expiration date.' description: 'IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: paymentVouchersReassess' operationId: nsk_v1_booking_payments_voucher_reassess_put responses: '200': description: The item was updated successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Agent Unauthorized to Reassess Voucher: description: Example response when the agent isn't authorized to reassess vouchers. value: errors: - id: 566a64d8-23f9-0568-3712-612449e0ae91 code: nsk-server:PaymentsDidNotPassValidation message: nsk-server:PaymentsDidNotPassValidation type: Validation details: null rawMessage: The agent is not authorized to reassess voucher payments. 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 Reassessment of Vouchers Failed: description: Example response when the voucher reassessment failed. value: errors: - id: 23c0d2aa-9c93-9c37-f9e4-39276217cbb8 code: nsk:Voucher:ReassessVoucherPaymentsFailed message: nsk:Voucher:ReassessVoucherPaymentsFailed type: Error details: null rawMessage: The reassessment of voucher payments failed. 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: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/penalties: get: tags: - booking summary: Gets the booking penalty from the booking in state. description: 'GraphQL endpoint: bookingPenalties' operationId: nsk_v1_booking_penalties_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingPenalty' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/penalties/{cancelledJourneyKey}: delete: tags: - booking summary: Waives the penalty fees of the specified cancelled journey. description: 'If the journey key specified is for a non-cancelled journey, i.e. the journey exists in the booking in state, an exception will be thrown. To waive the penalty fee of a journey in the booking in state, please use /api/nsk/v1/booking/journeys/{journeyKey}/fees/penalty instead. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingPenaltiesDeleteByKey' operationId: nsk_v1_booking_penalties_cancelledJourneyKey_delete parameters: - name: cancelledJourneyKey in: path required: true description: The journey key of the cancelled journey. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/pointOfSale: put: tags: - booking summary: Updates the booking point of sale. description: 'The ISO country code cannot be updated for a committed booking. This value can only be updated on an uncommitted booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingPointOfSaleSet' operationId: nsk_v1_booking_pointOfSale_put requestBody: x-name: request description: Details to update the point of sale. content: application/json: schema: $ref: '#/components/schemas/BookingPointOfSaleEditRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking summary: Updates the booking point of sale. description: 'The ISO country code cannot be updated for a committed booking. This value can only be updated on an uncommitted booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingPointOfSaleModify' operationId: nsk_v1_booking_pointOfSale_patch requestBody: x-name: request description: Details to update the point of sale. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfBookingPointOfSaleEditRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/prepaidExternal: post: tags: - booking summary: Creates a new prepaid external payment on the booking in state. description: 'This endpoint requires agent permissions. The payment fields are dynamic to the criteria of your payment provider. Here is an example request for a credit card payment that does not require address, zip, etc. { "amount": 10, "currencyCode": "USD", "paymentFields": {"ACCTNO":"411111111111", "EXPDATE":"10/8/2017", "CC::AccountHolderName":"Bob Smith", "CC::VerificationCode":"111"}} `IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: paymentPrepaidExternal' operationId: nsk_v1_booking_prepaidExternal_post parameters: - name: prepaidApprovalCode in: query description: "The prepaid approval code. This maps to a payment field with\ \ PrepaidApprovalCode as the system field type\n(configured in Utilities\ \ - Payment Types).\n " schema: type: string nullable: true x-position: 2 requestBody: x-name: request description: The payment request. content: application/json: schema: $ref: '#/components/schemas/PaymentMethodRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/price: put: tags: - booking summary: Applies fares, discounts and taxes to the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: priceSet' operationId: nsk_v1_booking_price_put requestBody: x-name: priceRequest description: The price request. content: application/json: schema: $ref: '#/components/schemas/PriceRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/price/validation: get: tags: - booking summary: Validates the fare prices on the booking in state. description: 'This endpoint is only recommended to be used with Fare Manager Plus and CAT1 validation is not fully supported in this endpoint outside of 4.5.2. GraphQL endpoint: priceValidate' operationId: nsk_v1_booking_price_validation_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Failed Fare Restrictions: description: Example response when booking has failed fare restrictions value: errors: - id: 26b205f5-6db8-4b6f-ab9b-5697d5f9e3f7 code: nsk:Booking:FailedFareRestriction message: nsk:Booking:FailedFareRestriction type: Error details: failedFareRestrictions: 'Failed passenger eligibility restrictions Carrier: XY Rule Number: DA0X Fare Basis: HBUDDY New Skies Default Tariff Market: DTW-EWR' rawMessage: 'Failed passenger eligibility restrictions Carrier: XY Rule Number: DA0X Fare Basis: HBUDDY New Skies Default Tariff Market: DTW-EWR' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/booking/promotion: post: tags: - booking summary: Sets a promotion code to a booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingPromotionCodeSet' operationId: nsk_v1_booking_promotion_post requestBody: x-name: request description: Promotion request. content: application/json: schema: $ref: '#/components/schemas/PromotionRequest' examples: Promotion request: description: Example request for adding a promotion code value: promotionCode: PROMO1 organizationCode: null Promotion request with organization code: description: Example request for adding a promotion code value: promotionCode: PROMO1 organizationCode: Organization ABC required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Promotion Already On Booking Error: description: Example error when attempting to add a promotion to a booking that already has a promotion applied. value: errors: - id: null code: nsk:Validation:ObjectAlreadyExists message: nsk:Validation:ObjectAlreadyExists type: Validation details: null rawMessage: Object already exists. 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 Requested Promotion Code Too Long: description: Example error when attempting to add a promotion code with more than 8 characters. value: errors: - id: null code: PromotionRequest.PromotionCode:StringLengthAttribute message: The field PromotionRequest must be a string with a maximum length of 8. type: Validation details: null rawMessage: The field PromotionRequest must be a string with a maximum length of 8. 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 Non-Existent Promotion Code: description: Example error when attempting to use a promotion code that does not exist. value: errors: - id: null code: nsk-server:PromotionNotFound message: nsk-server:PromotionNotFound type: Information details: null rawMessage: 'Specified promotion does not exist: PROMO22' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking summary: Updates a promotion code to a booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingPromotionCodeSet' operationId: nsk_v1_booking_promotion_put requestBody: x-name: request description: Promotion request. content: application/json: schema: $ref: '#/components/schemas/PromotionRequest' examples: Promotion request: description: Example request for adding a promotion code value: promotionCode: PROMO1 organizationCode: null Promotion request with organization code: description: Example request for adding a promotion code value: promotionCode: PROMO1 organizationCode: Organization ABC required: true x-position: 1 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Promotion Updated: description: Example when the promotion has been successfully updated value: data: null Expired Promotion: description: Example warning when attempting to add an expired promotion value: messages: - rawValue: 'Promotion AUTPCAA is not valid for organization: ORG1.' code: PromotionNotApplied debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Information value: PromotionNotApplied status: 0 details: null data: null '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Same Promotion Already On Booking Error: description: Example error when attempting to update the promotion on the booking to the same promotion that is already on the booking. value: errors: - id: null code: nsk:Booking:NotModified message: nsk:Booking:NotModified type: Validation details: null rawMessage: Booking was not modified. 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 Requested Promotion Code Too Long: description: Example error when attempting to add a a promotion code with more than 8 characters. value: errors: - id: null code: PromotionRequest.PromotionCode:StringLengthAttribute message: The field PromotionRequest must be a string with a maximum length of 8. type: Validation details: null rawMessage: The field PromotionRequest must be a string with a maximum length of 8. 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 Non-Existent Promotion Code: description: Example error when attempting to use a promotion code that does not exist. value: errors: - id: null code: nsk-server:PromotionNotFound message: nsk-server:PromotionNotFound type: Information details: null rawMessage: 'Specified promotion does not exist: PROMO22' 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 No Promotion Code On Booking: description: Example error when attempting to update a promotion code when none is on the booking. value: errors: - id: null code: nsk:Validation:ObjectNotFound message: nsk:Validation:ObjectNotFound type: Validation details: null rawMessage: The object is not found. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking summary: Deletes the promotion code on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingPromotionCodeDelete' operationId: nsk_v1_booking_promotion_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No Promotion Code On Booking: description: Example error when attempting to delete a promotion code when none is on the booking. value: errors: - id: null code: nsk:Validation:ObjectNotFound message: nsk:Validation:ObjectNotFound type: Validation details: null rawMessage: The object is not found. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/queue: post: tags: - booking summary: Adds the booking from state to a booking queue. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingEnqueuev3' operationId: nsk_v3_booking_queue_post requestBody: x-name: request description: The booking request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueRequestv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Enqueue Booking, Queue Code Does Not Exist: description: Example error when trying to add a booking to a queue, and the requested queue code does not exist. value: errors: - id: null code: nsk-server:BookingQueueDoesNotExist message: nsk-server:BookingQueueDoesNotExist type: Information details: null rawMessage: Booking Queue 'ZZZZZ' does not exist in the DB.. 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 Manual Queueing for Queue Code Not Allowed: description: Example error when trying to add a booking to a queue, and manual queueing from that queue is not allowed. value: errors: - id: null code: nsk-server:InvalidSelfServiceRebookingQueuing message: nsk-server:InvalidSelfServiceRebookingQueuing type: Information details: null rawMessage: Manual queuing from a Self-Service Rebooking Booking Queue is not allowed. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v2/booking/queue: post: tags: - booking summary: Adds the booking from state to a booking queue. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingEnqueuev2' operationId: nsk_v2_booking_queue_post requestBody: x-name: request description: The booking request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueRequestv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true delete: tags: - booking summary: Removes the booking in state from a booking queue. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingDequeuev2' operationId: nsk_v2_booking_queue_delete requestBody: x-name: request description: The booking request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueDeleteRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/queues/{bookingQueueKey}: delete: tags: - booking summary: Removes the booking in state from the specified booking queue item. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingDequeueByKey' operationId: nsk_v1_booking_queues_bookingQueueKey_delete parameters: - name: bookingQueueKey in: path required: true description: The unique key of the booking queue to dequeue from. schema: type: string x-position: 1 requestBody: x-name: request description: The request for the dequeue operation. content: application/json: schema: $ref: '#/components/schemas/BookingQueueDeleteByKeyRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/recordLocators: get: tags: - booking summary: Gets all of the record locators on the in-state booking. description: 'GraphQL endpoint: recordLocators' operationId: nsk_v1_booking_recordLocators_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfRecordLocator' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - booking summary: Adds a third party record locator to the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorsAdd' operationId: nsk_v1_booking_recordLocators_post requestBody: x-name: request description: The record locator request. content: application/json: schema: $ref: '#/components/schemas/RecordLocatorCreateRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking summary: Deletes all record locators from the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorsDelete' operationId: nsk_v1_booking_recordLocators_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/recordLocators/{recordLocatorKey}: get: tags: - booking summary: 'Gets the record locator associated with the record locator key for the in-state booking.' description: 'GraphQL endpoint: recordLocator' operationId: nsk_v1_booking_recordLocators_recordLocatorKey_get parameters: - name: recordLocatorKey in: path required: true description: The record locator key to retrieve. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRecordLocator' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking summary: Replaces the data of a third party record locator on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorsSet' operationId: nsk_v1_booking_recordLocators_recordLocatorKey_put parameters: - name: recordLocatorKey in: path required: true description: The record locator key to update. schema: type: string x-position: 1 requestBody: x-name: request description: The record locator update request. content: application/json: schema: $ref: '#/components/schemas/RecordLocatorEditRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - booking summary: Patches the data of a third party record locator on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorsModify' operationId: nsk_v1_booking_recordLocators_recordLocatorKey_patch parameters: - name: recordLocatorKey in: path required: true description: The record locator key to update. schema: type: string x-position: 1 requestBody: x-name: request description: The record locator update request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfRecordLocatorEditRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking summary: Deletes a record locator from the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: recordLocatorDelete' operationId: nsk_v1_booking_recordLocators_recordLocatorKey_delete parameters: - name: recordLocatorKey in: path required: true description: The record locator key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/reinstate: put: tags: - booking summary: Reinstates a booking with a status of hold canceled. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingReinstate' operationId: nsk_v1_booking_reinstate_put responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Reinstate Successful: description: Example when booking is Reinstated Successfully value: data: null Failed To Assign All Seats Message: description: Example OSI Message when reinstating a booking with no available seats value: messages: - rawValue: 'Failed to assign seat(s) for passenger Aurelio David on the flight NV5682 SLCBOS Detail: Seats cannot be assigned on flight segment NV5682 SLC-BOS for 12/01/2023 due to either one of the following: anchor unit Y/3E was not selected, insufficient number of available seats for 1 passenger (2 total). ' code: FailedToAssignAllSeats debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedToAssignAllSeats value: null status: 0 details: reinstateGeneralMessage: 'Failed to assign seat(s) for passenger Aurelio David on the flight NV5682 SLCBOS Detail: Seats cannot be assigned on flight segment NV5682 SLC-BOS for 12/01/2023 due to either one of the following: anchor unit Y/3E was not selected, insufficient number of available seats for 1 passenger (2 total). ' data: null SSR Is Unavailable Message: description: Example OSI Message when reinstating a booking with no available SSRs value: messages: - rawValue: 'A SSR could not be sold for the following SSR, passenger and flight: LEGX|MCFBRFQ-|NV5683 |DEN|SLC|2023-11-17T00:00:00.0000000' code: SSRIsUnavailable debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: SSRIsUnavailable value: null status: 0 details: ssrCode: LEGX passengerKey: MCFBRFQ- carrierCode: NV flightNumber: '5683' opSuffix: null origin: DEN destination: SLC departureDate: '2023-11-17T00:00:00' data: null Failed To Reinstate Journey Message: description: Example OSI Message when reinstating a multi journey booking where there is at least one journey with no available AUs and at least one journey that succeeded to reinstate. value: messages: - rawValue: 'Failed to reinstate journey: 20231101 NV 5682 SLCBOS. Reason: The requested class of service is sold out.' code: FailedToReinstateJourney debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedToReinstateJourney value: null status: 1 details: reinstateWarningMessage: 'Failed to reinstate journey: 20231101 NV 5682 SLCBOS. Reason: The requested class of service is sold out.' data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Reinstate Restricted On Non HoldCanceled Error: description: Example error when Reinstating a booking that is not Hold Canceled. value: errors: - id: null code: nsk:Booking:ReinstateRestrictedOnNonHoldCanceled message: nsk:Booking:ReinstateRestrictedOnNonHoldCanceled type: Validation details: null rawMessage: Unable to reinstate a booking that is not hold canceled. 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 No Booking In State Error: description: Example error when Reinstating without a booking in state. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Failed To Reinstate Journey Error: description: Example error when all journeys failed to reinstate. value: errors: - id: null code: FailedToReinstateJourney message: FailedToReinstateJourney type: Error details: reinstateErrorMessage: 'Failed to reinstate journey: 20231101 NV 5682 SLCBOS. Reason: The requested class of service is not offered on this flight.' rawMessage: 'Failed to reinstate journey: 20231101 NV 5682 SLCBOS. Reason: The requested class of service is not offered on this flight.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/reset: delete: tags: - booking summary: Clears the current booking state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingReset' operationId: nsk_v1_booking_reset_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/retrieve: get: tags: - booking/retrieve summary: 'Retrieves the booking from the New Skies server based on the retrieve booking request parameters and any configured booking retrieve strategies. If the booking exists and the search criteria is allowed by one of the configured booking retrieve strategies, the booking will be loaded into the web session and returned.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This endpoint will perform validation using a pre-configured booking retrieve strategy. Custom strategies can be configured in Utilities, and are configurable based on application name. To set up a custom strategy, go to Utilities -> Resource Management. From the "Resource Management" screen, go to Root -> Web -> dotREZ folder. Right-click on the dotREZ folder and select "Add Content". On the "Add Resource" screen, set the "Content Name" to "BookingStrategyManagementConfig". Choose "XML" as the "Type". The "Content Data" will be in JSON, and should look like this: { "strategies" : [{ "applicationName" : "dotREZApi", "allowedStrategies" : [ "firstAndLastName", "email" ] }, { "applicationName" : "Web", "allowedStrategies" : [ "email" ] }, { "applicationName" : "", "allowedStrategies" : [ "lastName" ] }] } The application name can be set when creating a new token. If no application name is given for a token create request, the API will use whatever value is defined in the "dotrez-nsk-common.json" configuration file under the "systemOptions" -> "fallbackApplicationName". If no strategies are configured and no "fallbackApplicationName" is configured, the default strategy will be a booking retrieve based on PNR, first name, and last name. If the same strategy should be used for multiple applications, the last entry in the example above can be set by setting an empty string as the application name, and then listing the allowed strategies to be used. Application specific strategies can still be defined, but if no application specific strategy is found, a list of strategies associated with the blank application name will be used (if one exists in the configuration file). The list of strategies currently includes the following options: firstAndLastName email originAndDepartureDate lastName customerNumber More strategies may be added in the future. GraphQL endpoint: bookingRetrievev3' operationId: nsk_v2_booking_retrieve_get parameters: - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: string maxLength: 12 minLength: 0 nullable: true x-position: 1 - name: EmailAddress in: query description: "The email address of a contact.\n " schema: type: string maxLength: 266 minLength: 0 nullable: true x-position: 2 - name: Origin in: query description: "The origin station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 3 - name: FirstName in: query description: "The first name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 4 - name: LastName in: query description: "The last name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 5 - name: CustomerNumber in: query description: "One of the passengers customer numbers applied.\n \ \ " schema: type: string maxLength: 20 minLength: 0 nullable: true x-position: 6 - name: DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:14.2658737Z' createdDate: '2026-07-09T05:55:14.2658739Z' expirationDate: '2026-07-12T05:55:14.265874Z' modifiedDate: '2026-07-09T05:58:14.2658756Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:14.2658796Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:14.2659078Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:14.2659108Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:14.2659158+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:14.2659139Z' number: P31322423218 issuedDate: '2025-07-09T05:55:14.2659146Z' gender: 1 dateOfBirth: '2025-07-09T05:55:14.2659149Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:14.2659232Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:14.2659179Z' number: P31322423218 issuedDate: '2016-07-09T05:55:14.2659181Z' gender: 1 dateOfBirth: '2002-07-09T05:55:14.2659182Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:14.2659206Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:14.2659524Z' departure: '2026-07-09T05:55:14.2659526Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:14.2659524Z' departure: '2026-07-09T05:55:14.2659526Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:14.2659278Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:14.2659292Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:14.2659294Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:14.2659297Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:14.2659298Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:14.2659351Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:14.265942Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:14.2659438Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:14.2659451Z' actualOnBlockTime: '2026-07-10T05:55:14.2659453Z' actualTouchDownTime: '2026-07-11T05:55:14.2659455Z' airborneTime: '2026-07-10T08:55:14.2659456Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:14.2659461Z' estimated: '2026-07-09T05:45:14.2659463Z' standardArrivalTime: '2026-07-10T05:55:14.2659465Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:14.2659524Z' departure: '2026-07-09T05:55:14.2659526Z' legInfo: departureTimeUtc: '2026-07-09T12:55:14Z' arrivalTimeUtc: '2026-07-10T10:55:14Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:14.2659489Z' departureTime: '2026-07-09T05:55:14.265949Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:14.2659543Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:14.2659571Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:14.2659588Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:14.2659597Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:14.2659613Z' transactionCode: TRANSACTION dcc: rateId: 3735298f-85c5-419c-904b-98c40379ae30 currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:14.2659732Z' modifiedDate: '2026-07-09T06:00:14.2659734Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:14.2659787Z' beginLocation: SLC endDate: '2026-07-16T05:55:14.2659788Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:14.2659798Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:14.2659803Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:14.2659863Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:14.2659884Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:14.2659894Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:14.2659905Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:14.2659982Z' modified: '2026-07-09T06:25:14.2659982Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: 330b30b8-f608-4a38-a96f-1d0ae31d1aee collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid search criteria: description: The search parameters used did not meet the configured strategy in the Management Console. For more information about setting up the strategies, please refer to the Navitaire Developer Portal. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: Invalid search criteria 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 Validation failed: description: The booking associated with the record locator is not found or the provided search parameters didn't match with the booking. The value for the `rawMessage` might differ depending on the strategy used. Aside from the first and last name, it could be email, customer number, last name or origin and departure date. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: First and last name validation failed 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 Agent not allowed to view past-dated bookings: description: The agent is not allowed to retrieve past-dated bookings that are outside the configured number of days in the Management Console. value: errors: - id: null code: nsk-server:AuthorizationViewPastDatedBookingNotAllowed message: nsk-server:AuthorizationViewPastDatedBookingNotAllowed type: Validation details: null rawMessage: Agent is not allowed to retrieve the booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/retrieve/{bookingKey}: get: tags: - booking/retrieve summary: Gets a specific booking by key and stores it in state. description: 'This endpoint requires a session token and is agent-only. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingRetrieveByKey' operationId: nsk_v1_booking_retrieve_bookingKey_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:13.0790691Z' createdDate: '2026-07-09T05:55:13.0790692Z' expirationDate: '2026-07-12T05:55:13.0790693Z' modifiedDate: '2026-07-09T05:58:13.0790705Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:13.0790754Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:13.0791027Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:13.0791052Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:13.0791137+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:13.0791077Z' number: P31322423218 issuedDate: '2025-07-09T05:55:13.0791125Z' gender: 1 dateOfBirth: '2025-07-09T05:55:13.0791128Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:13.0791211Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:13.0791156Z' number: P31322423218 issuedDate: '2016-07-09T05:55:13.0791157Z' gender: 1 dateOfBirth: '2002-07-09T05:55:13.0791158Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:13.0791179Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.079145Z' departure: '2026-07-09T05:55:13.0791451Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.079145Z' departure: '2026-07-09T05:55:13.0791451Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:13.0791243Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:13.0791256Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:13.0791258Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:13.0791259Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:13.0791262Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.0791313Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:13.0791365Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:13.0791381Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:13.0791391Z' actualOnBlockTime: '2026-07-10T05:55:13.0791392Z' actualTouchDownTime: '2026-07-11T05:55:13.0791394Z' airborneTime: '2026-07-10T08:55:13.0791395Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:13.0791401Z' estimated: '2026-07-09T05:45:13.0791402Z' standardArrivalTime: '2026-07-10T05:55:13.0791404Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.079145Z' departure: '2026-07-09T05:55:13.0791451Z' legInfo: departureTimeUtc: '2026-07-09T12:55:13Z' arrivalTimeUtc: '2026-07-10T10:55:13Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:13.0791423Z' departureTime: '2026-07-09T05:55:13.0791424Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:13.0791466Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:13.0791495Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:13.079151Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:13.0791519Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:13.079154Z' transactionCode: TRANSACTION dcc: rateId: 696ae9fa-b948-462e-a395-2ca6bdd3cfcd currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:13.0791653Z' modifiedDate: '2026-07-09T06:00:13.0791654Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:13.0791701Z' beginLocation: SLC endDate: '2026-07-16T05:55:13.0791702Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:13.0791712Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:13.0791716Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:13.0791771Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:13.079179Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:13.0791795Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:13.0791804Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:13.0791855Z' modified: '2026-07-09T06:25:13.0791855Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: 56b78122-d5bf-4465-b96a-7c5e7c3b2821 collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '401': description: No token provided or the token type (typically anonymous type) has insufficient access. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: The booking key is invalid: description: The booking key cannot be decoded correctly or no booking is associated with the key. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'bookingKey' with value 'NjI2OTAhR0IzMkZLIWZhbHNl' is invalid. type: Validation details: null rawMessage: The identifier 'bookingKey' with value 'NjI2OTAhR0IzMkZLIWZhbHNl' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Agent not allowed to view past-dated bookings: description: The agent is not allowed to retrieve past-dated bookings that are outside the configured number of days in the Management Console. value: errors: - id: null code: nsk-server:AuthorizationViewPastDatedBookingNotAllowed message: nsk-server:AuthorizationViewPastDatedBookingNotAllowed type: Validation details: null rawMessage: Agent is not allowed to retrieve the booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Agent not allowed to view or update the booking: description: The agent has no permission to view or modify the booking. value: errors: - id: null code: nsk-server:AuthorizationGroupAccessNotAllowed message: nsk-server:AuthorizationGroupAccessNotAllowed type: Validation details: null rawMessage: 'Agent is not allowed to view/update the requested booking. Role Code: TAW3' 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. '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/retrieve/byBookingId/{bookingId}: get: tags: - booking/retrieve summary: Gets a specific booking by ID and stores it in state. description: 'This endpoint requires a session token and is agent-only. Archived bookings cannot be retrieved with this endpoint. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingRetrieveByBookingId' operationId: nsk_v1_booking_retrieve_byBookingId_bookingId_get parameters: - name: bookingId in: path required: true description: The booking ID. schema: type: integer format: int64 x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:13.0821356Z' createdDate: '2026-07-09T05:55:13.0821357Z' expirationDate: '2026-07-12T05:55:13.0821358Z' modifiedDate: '2026-07-09T05:58:13.0821367Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:13.0821403Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:13.0821606Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:13.0821632Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:13.0821665+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:13.0821652Z' number: P31322423218 issuedDate: '2025-07-09T05:55:13.0821657Z' gender: 1 dateOfBirth: '2025-07-09T05:55:13.082166Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:13.0821716Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:13.0821678Z' number: P31322423218 issuedDate: '2016-07-09T05:55:13.0821678Z' gender: 1 dateOfBirth: '2002-07-09T05:55:13.082168Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:13.0821698Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.0821924Z' departure: '2026-07-09T05:55:13.0821926Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.0821924Z' departure: '2026-07-09T05:55:13.0821926Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:13.0821744Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:13.0821753Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:13.0821755Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:13.0821756Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:13.0821757Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.0821812Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:13.0821852Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:13.0821864Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:13.0821872Z' actualOnBlockTime: '2026-07-10T05:55:13.0821873Z' actualTouchDownTime: '2026-07-11T05:55:13.0821875Z' airborneTime: '2026-07-10T08:55:13.0821876Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:13.082188Z' estimated: '2026-07-09T05:45:13.0821881Z' standardArrivalTime: '2026-07-10T05:55:13.0821883Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.0821924Z' departure: '2026-07-09T05:55:13.0821926Z' legInfo: departureTimeUtc: '2026-07-09T12:55:13Z' arrivalTimeUtc: '2026-07-10T10:55:13Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:13.0821902Z' departureTime: '2026-07-09T05:55:13.0821902Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:13.082194Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:13.0821962Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:13.0821968Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:13.0821974Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:13.0821984Z' transactionCode: TRANSACTION dcc: rateId: 2dfa25ce-d908-40e0-ba37-fa18c53473fd currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:13.0822077Z' modifiedDate: '2026-07-09T06:00:13.0822079Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:13.0822118Z' beginLocation: SLC endDate: '2026-07-16T05:55:13.082212Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:13.0822131Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:13.0822135Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:13.0822174Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:13.082219Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:13.0822195Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:13.0822202Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:13.0822259Z' modified: '2026-07-09T06:25:13.082226Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: d226a572-95f8-4d3b-addf-614ebdb9c87d collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '401': description: No token provided or the token type (typically anonymous type) has insufficient access. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: The booking key is invalid: description: The booking key cannot be decoded correctly or no booking is associated with the key. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'bookingKey' with value 'NjI2OTAhR0IzMkZLIWZhbHNl' is invalid. type: Validation details: null rawMessage: The identifier 'bookingKey' with value 'NjI2OTAhR0IzMkZLIWZhbHNl' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Agent not allowed to view past-dated bookings: description: The agent is not allowed to retrieve past-dated bookings that are outside the configured number of days in the Management Console. value: errors: - id: null code: nsk-server:AuthorizationViewPastDatedBookingNotAllowed message: nsk-server:AuthorizationViewPastDatedBookingNotAllowed type: Validation details: null rawMessage: Agent is not allowed to retrieve the booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Agent not allowed to view or update the booking: description: The agent has no permission to view or modify the booking. value: errors: - id: null code: nsk-server:AuthorizationGroupAccessNotAllowed message: nsk-server:AuthorizationGroupAccessNotAllowed type: Validation details: null rawMessage: 'Agent is not allowed to view/update the requested booking. Role Code: TAW3' 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. '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/retrieve/byRecordLocator/{recordLocator}: get: tags: - booking/retrieve summary: Gets a specific booking by record locator and stores it in state. description: 'This endpoint requires a session token and is agent-only. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingRetrieveByRecordLocator' operationId: nsk_v1_booking_retrieve_byRecordLocator_recordLocator_get parameters: - name: recordLocator in: path required: true description: The booking record locator. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:13.0851723Z' createdDate: '2026-07-09T05:55:13.0851724Z' expirationDate: '2026-07-12T05:55:13.0851725Z' modifiedDate: '2026-07-09T05:58:13.0851733Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:13.0851752Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:13.0851908Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:13.0851922Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:13.0851953+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:13.0851938Z' number: P31322423218 issuedDate: '2025-07-09T05:55:13.0851943Z' gender: 1 dateOfBirth: '2025-07-09T05:55:13.0851945Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:13.0851991Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:13.0851963Z' number: P31322423218 issuedDate: '2016-07-09T05:55:13.0851964Z' gender: 1 dateOfBirth: '2002-07-09T05:55:13.0851965Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:13.0851977Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.0852178Z' departure: '2026-07-09T05:55:13.0852178Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.0852178Z' departure: '2026-07-09T05:55:13.0852178Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:13.0852027Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:13.0852034Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:13.0852035Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:13.0852036Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:13.0852037Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.0852064Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:13.0852091Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:13.08521Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:13.0852105Z' actualOnBlockTime: '2026-07-10T05:55:13.0852106Z' actualTouchDownTime: '2026-07-11T05:55:13.0852107Z' airborneTime: '2026-07-10T08:55:13.0852108Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:13.0852111Z' estimated: '2026-07-09T05:45:13.0852112Z' standardArrivalTime: '2026-07-10T05:55:13.0852113Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.0852178Z' departure: '2026-07-09T05:55:13.0852178Z' legInfo: departureTimeUtc: '2026-07-09T12:55:13Z' arrivalTimeUtc: '2026-07-10T10:55:13Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:13.0852163Z' departureTime: '2026-07-09T05:55:13.0852164Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:13.0852187Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:13.0852202Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:13.0852206Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:13.085221Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:13.0852219Z' transactionCode: TRANSACTION dcc: rateId: 31d4743c-c600-454d-8b31-102a0b8971de currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:13.0852292Z' modifiedDate: '2026-07-09T06:00:13.0852294Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:13.0852316Z' beginLocation: SLC endDate: '2026-07-16T05:55:13.0852317Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:13.0852323Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:13.0852326Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:13.0852353Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:13.085237Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:13.0852374Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:13.0852379Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:13.0852416Z' modified: '2026-07-09T06:25:13.0852417Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: 3c5b0006-17cf-403e-92ae-477c5c2af158 collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid record locator: description: The record locator provided is null, empty, or exceeded the maximum length. value: errors: - id: 96a5f7a8-184b-0284-7b76-37f03eba38bb code: nsk:Booking:InvalidRecordLocator message: The record locator AZJVGLAZJVGLAZJVGL is not valid. type: Validation details: recordLocator: AZJVGLAZJVGLAZJVGL rawMessage: The record locator AZJVGLAZJVGLAZJVGL is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Non-existent booking: description: The booking associated with the record locator is not found. value: errors: - id: effe2fb4-0ff9-d384-37e6-47af652bdea3 code: nsk:Exceptions:InvalidKey message: The identifier 'recordLocator' with value 'AZJVGL' is invalid. type: Validation details: recordLocator: AZJVGL rawMessage: The identifier 'recordLocator' with value 'AZJVGL' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Agent not allowed to view past-dated bookings: description: The agent is not allowed to retrieve past-dated bookings that are outside the configured number of days in the Management Console. value: errors: - id: null code: nsk-server:AuthorizationViewPastDatedBookingNotAllowed message: nsk-server:AuthorizationViewPastDatedBookingNotAllowed type: Validation details: null rawMessage: Agent is not allowed to retrieve the booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Agent not allowed to view or update the booking: description: The agent has no permission to view or modify the booking. value: errors: - id: null code: nsk-server:AuthorizationGroupAccessNotAllowed message: nsk-server:AuthorizationGroupAccessNotAllowed type: Validation details: null rawMessage: 'Agent is not allowed to view/update the requested booking. Role Code: TAW3' 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. '401': description: No token provided or the token type (typically anonymous type) has insufficient access. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/retrieve/byThirdPartyRecordLocator: get: tags: - booking/retrieve summary: Gets a specific booking by third-party record locator and stores it in state. description: 'This endpoint requires a session token and is agent-only. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingRetrieveByThirdPartyRecordLocator' operationId: nsk_v1_booking_retrieve_byThirdPartyRecordLocator_get parameters: - name: SystemCode in: query description: "System Code being requested.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 1 - name: ThirdPartyRecordLocator in: query description: "The Third Party Record Locator of the booking being requested.\n\ \ " schema: type: string maxLength: 12 minLength: 0 nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:13.0884422Z' createdDate: '2026-07-09T05:55:13.0884423Z' expirationDate: '2026-07-12T05:55:13.0884424Z' modifiedDate: '2026-07-09T05:58:13.088443Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:13.0884447Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:13.0884591Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:13.0884605Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:13.0884629+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:13.0884618Z' number: P31322423218 issuedDate: '2025-07-09T05:55:13.0884622Z' gender: 1 dateOfBirth: '2025-07-09T05:55:13.0884623Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:13.0884668Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:13.0884642Z' number: P31322423218 issuedDate: '2016-07-09T05:55:13.0884643Z' gender: 1 dateOfBirth: '2002-07-09T05:55:13.0884644Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:13.0884655Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.0884802Z' departure: '2026-07-09T05:55:13.0884803Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.0884802Z' departure: '2026-07-09T05:55:13.0884803Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:13.0884687Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:13.0884694Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:13.0884695Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:13.0884696Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:13.0884697Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.0884729Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:13.0884757Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:13.0884764Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:13.088477Z' actualOnBlockTime: '2026-07-10T05:55:13.0884771Z' actualTouchDownTime: '2026-07-11T05:55:13.0884772Z' airborneTime: '2026-07-10T08:55:13.0884773Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:13.0884776Z' estimated: '2026-07-09T05:45:13.0884776Z' standardArrivalTime: '2026-07-10T05:55:13.0884778Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.0884802Z' departure: '2026-07-09T05:55:13.0884803Z' legInfo: departureTimeUtc: '2026-07-09T12:55:13Z' arrivalTimeUtc: '2026-07-10T10:55:13Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:13.0884789Z' departureTime: '2026-07-09T05:55:13.088479Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:13.0884811Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:13.0884826Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:13.0884831Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:13.0884835Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:13.0884843Z' transactionCode: TRANSACTION dcc: rateId: 29708d6e-7f22-4183-81f9-106fff041221 currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:13.0884918Z' modifiedDate: '2026-07-09T06:00:13.0884919Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:13.088494Z' beginLocation: SLC endDate: '2026-07-16T05:55:13.0884941Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:13.0884947Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:13.088495Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:13.0884975Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:13.0884986Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:13.088499Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:13.0884995Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:13.0885043Z' modified: '2026-07-09T06:25:13.0885044Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: 16dad90b-dfc8-4436-9266-69c8fadf77c0 collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '401': description: No token provided or the token type (typically anonymous type) has insufficient access. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Non-existent booking: description: The booking associated with the third-party record locator is not found. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'ThirdPartyRecordLocator' with value '12345678' is invalid. type: Validation details: null rawMessage: The identifier 'bookingKey' with value '12345678' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Agent not allowed to view past-dated bookings: description: The agent is not allowed to retrieve past-dated bookings that are outside the configured number of days in the Management Console. value: errors: - id: null code: nsk-server:AuthorizationViewPastDatedBookingNotAllowed message: nsk-server:AuthorizationViewPastDatedBookingNotAllowed type: Validation details: null rawMessage: Agent is not allowed to retrieve the booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Agent not allowed to view or update the booking: description: The agent has no permission to view or modify the booking. value: errors: - id: null code: nsk-server:AuthorizationGroupAccessNotAllowed message: nsk-server:AuthorizationGroupAccessNotAllowed type: Validation details: null rawMessage: 'Agent is not allowed to view/update the requested booking. Role Code: TAW3' 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. '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/salesChannel: put: tags: - booking summary: Overrides the effective sales channel for the booking in state. description: 'For the overriden channel to be implemented, the booking in state must be committed after calling this endpoint. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: salesChannelSet' operationId: nsk_v1_booking_salesChannel_put parameters: - name: channelType in: query description: "The sales channel type to override to. \nEnumeration values:\ \ 0 = Direct, 1 = Web, 2 = Api, 3 = DigitalApi, 4 = DigitalWeb, 5 = Ndc" schema: nullable: true $ref: '#/components/schemas/OverrideChannelType' x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/seatmaps: get: tags: - booking/seatmaps summary: Gets the list of seat maps for all the journeys for the booking in state. description: 'GraphQL endpoint: seatMapsv3' operationId: nsk_v3_booking_seatmaps_get parameters: - name: FeePricingMode in: query description: "Fee pricing mode.\n \nEnumeration values: 0 = MonetaryOnly,\ \ 1 = PointsOnly" schema: nullable: true $ref: '#/components/schemas/FeePricingMode' x-position: 1 - name: CollectedCurrencyCode in: query description: "The collected currency code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: IncludePropertyLookup in: query description: "Flag indicating to include seat property lookup on the response.\n\ \ " schema: type: boolean nullable: true x-position: 3 - name: CultureCode in: query description: "The desired culture code.\n " schema: type: string nullable: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSeatMapAvailability' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v4/booking/seatmaps/journey/{journeyKey}: get: tags: - booking/seatmaps summary: Gets the list of seat maps for an entire journey. description: 'GraphQL endpoint: seatMapsByJourneyKeyv3' operationId: nsk_v4_booking_seatmaps_journey_journeyKey_get parameters: - name: journeyKey in: path required: true description: The unique journey key. schema: type: string x-position: 1 - name: FeePricingMode in: query description: "Fee pricing mode.\n \nEnumeration values: 0 = MonetaryOnly,\ \ 1 = PointsOnly" schema: nullable: true $ref: '#/components/schemas/FeePricingMode' x-position: 2 - name: CollectedCurrencyCode in: query description: "The collected currency code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 3 - name: IncludePropertyLookup in: query description: "Flag indicating to include seat property lookup on the response.\n\ \ " schema: type: boolean nullable: true x-position: 4 - name: CultureCode in: query description: "The desired culture code.\n " schema: type: string nullable: true x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSeatMapAvailability' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/seatmaps/segment/{segmentKey}: get: tags: - booking/seatmaps summary: Gets the list of seat maps for a specific journey's segment. description: 'GraphQL endpoint: seatMapsBySegmentKeyv3' operationId: nsk_v3_booking_seatmaps_segment_segmentKey_get parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 - name: FeePricingMode in: query description: "Fee pricing mode.\n \nEnumeration values: 0 = MonetaryOnly,\ \ 1 = PointsOnly" schema: nullable: true $ref: '#/components/schemas/FeePricingMode' x-position: 2 - name: CollectedCurrencyCode in: query description: "The collected currency code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 3 - name: IncludePropertyLookup in: query description: "Flag indicating to include seat property lookup on the response.\n\ \ " schema: type: boolean nullable: true x-position: 4 - name: CultureCode in: query description: "The desired culture code.\n " schema: type: string nullable: true x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSeatMapAvailability' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/seats/auto: post: tags: - booking/seats summary: 'Auto assigns seats to all selected passengers that do not have them for every journey on the booking. If seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments. Otherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead. An invalid primary passenger key or invalid passenger keys are not accepted and will return a Bad Request Error.' description: 'GraphQL endpoint: autoAssignSeats' operationId: nsk_v1_booking_seats_auto_post requestBody: x-name: request description: The auto assign seat request. content: application/json: schema: $ref: '#/components/schemas/AutoAssignRequestv2' required: true x-position: 1 responses: '201': description: Seats auto-assigned. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '207': description: Multi-status. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Partial Failure.: description: Example response of a partially-successful auto-seat assignment. The failed seat assignments will each have a warning message. value: messages: - rawValue: 'Failed to assign seat(s) for passenger ANA MARIA Mateos on the flight VY3212 BCNTFN Detail: Seats cannot be assigned on flight segment VY3212 BCN-TFN for 09/19/2025 due to either one of the following: insufficient number of available seats for 1 passenger (1 total). ' code: FailedToAssignAllSeats debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedToAssignAllSeats value: FailedToAssignAllSeats status: 0 details: failedToAssignAllSeats: 'Failed to assign seat(s) for passenger ANA MARIA Mateos on the flight VY3212 BCNTFN Detail: Seats cannot be assigned on flight segment VY3212 BCN-TFN for 09/19/2025 due to either one of the following: insufficient number of available seats for 1 passenger (1 total). ' data: null /api/nsk/v1/booking/seats/auto/{primaryPassengerKey}: post: tags: - booking/seats summary: 'Auto assigns seats to all selected passengers that do not have them for every journey on the booking. If seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments. Otherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead.' description: 'GraphQL endpoint: seatAutoAssign' operationId: nsk_v1_booking_seats_auto_primaryPassengerKey_post parameters: - name: primaryPassengerKey in: path required: true description: The key for the primary passenger. schema: type: string x-position: 1 requestBody: x-name: request description: The auto assign seat request. content: application/json: schema: $ref: '#/components/schemas/AutoAssignRequest' required: true x-position: 2 responses: '201': description: Seats auto-assigned. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/seats/auto/{primaryPassengerKey}/journey/{journeyKey}: post: tags: - booking/seats summary: 'Auto assigns seats to all passengers that do not have them for a specific journey. If seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments. Otherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead.' description: 'GraphQL endpoint: seatAutoAssignJourney' operationId: nsk_v1_booking_seats_auto_primaryPassengerKey_journey_journeyKey_post parameters: - name: primaryPassengerKey in: path required: true description: The key for the primary passenger. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The specific journey key to auto assign. schema: type: string x-position: 2 requestBody: x-name: request description: The auto assign seat request. content: application/json: schema: $ref: '#/components/schemas/AutoAssignRequest' required: true x-position: 3 responses: '201': description: Seats auto-assigned. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/seats/auto/{primaryPassengerKey}/journey/{journeyKey}/quote: post: tags: - booking/seats summary: Retrieves the seat fee information of the auto-assigned seats of a passenger on a given journey. description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. GraphQL endpoint: passengerSeatFeeQuoteJourney' operationId: nsk_v1_booking_seats_auto_primaryPassengerKey_journey_journeyKey_quote_post parameters: - name: journeyKey in: path required: true description: "The key of the journey for the auto-assigned seat where the\ \ seat fee information will be\nbased.\n " schema: type: string x-position: 1 - name: primaryPassengerKey in: path required: true description: The key of the primary passenger being seated. schema: type: string x-position: 2 requestBody: x-name: request description: The seat fee quote request. content: application/json: schema: $ref: '#/components/schemas/AutoAssignSeatFeeQuoteRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfPassengerSeatFee' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/seats/auto/{primaryPassengerKey}/segment/{segmentKey}: post: tags: - booking/seats summary: 'Auto assigns seats to all passengers that do not have them for a specific journey''s segment. If seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments. Otherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead.' description: 'GraphQL endpoint: seatAutoAssignSegment' operationId: nsk_v1_booking_seats_auto_primaryPassengerKey_segment_segmentKey_post parameters: - name: primaryPassengerKey in: path required: true description: The key for the primary passenger. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The specific segment key to auto assign. schema: type: string x-position: 2 requestBody: x-name: request description: The auto assign seat request. content: application/json: schema: $ref: '#/components/schemas/AutoAssignRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/seats/auto/{primaryPassengerKey}/segment/{segmentKey}/quote: post: tags: - booking/seats summary: Retrieves the seat fee information of the auto-assigned seats of a passenger on a given segment. description: 'Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. GraphQL endpoint: passengerSeatFeeQuoteSegment' operationId: nsk_v1_booking_seats_auto_primaryPassengerKey_segment_segmentKey_quote_post parameters: - name: segmentKey in: path required: true description: "The key of the segment for the auto-assigned seat where the\ \ seat fee information will be\nbased.\n " schema: type: string x-position: 1 - name: primaryPassengerKey in: path required: true description: The key of the primary passenger being seated. schema: type: string x-position: 2 requestBody: x-name: request description: The seat fee quote request. content: application/json: schema: $ref: '#/components/schemas/AutoAssignSeatFeeQuoteRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfPassengerSeatFee' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/seats/auto/journey/{journeyKey}: post: tags: - booking/seats summary: 'Auto assigns seats to all passengers that do not have them for a specific journey. If seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments. Otherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead. An invalid primary passenger key or invalid passenger keys are not accepted and will return a Bad Request Error.' description: 'GraphQL endpoint: autoAssignSeatsJourney' operationId: nsk_v1_booking_seats_auto_journey_journeyKey_post parameters: - name: journeyKey in: path required: true description: The specific journey key to auto assign. schema: type: string x-position: 1 requestBody: x-name: request description: The auto assign seat request. content: application/json: schema: $ref: '#/components/schemas/AutoAssignRequestv2' required: true x-position: 2 responses: '201': description: Seats auto-assigned. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '207': description: Multi-status. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Partial Failure.: description: Example response of a partially-successful auto-seat assignment. The failed seat assignments will each have a warning message. value: messages: - rawValue: 'Failed to assign seat(s) for passenger ANA MARIA Mateos on the flight VY3212 BCNTFN Detail: Seats cannot be assigned on flight segment VY3212 BCN-TFN for 09/19/2025 due to either one of the following: insufficient number of available seats for 1 passenger (1 total). ' code: FailedToAssignAllSeats debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedToAssignAllSeats value: FailedToAssignAllSeats status: 0 details: failedToAssignAllSeats: 'Failed to assign seat(s) for passenger ANA MARIA Mateos on the flight VY3212 BCNTFN Detail: Seats cannot be assigned on flight segment VY3212 BCN-TFN for 09/19/2025 due to either one of the following: insufficient number of available seats for 1 passenger (1 total). ' data: null /api/nsk/v1/booking/seats/auto/segment/{segmentKey}: post: tags: - booking/seats summary: 'Auto assigns seats to all passengers that do not have them for a specific journey''s segment. If seatedNearPrimary is empty, all passengers in the state booking will be requested for seat assignments. Otherwise, passengers with a passenger key specified in seatedNearPrimary will be requested instead. An invalid primary passenger key or invalid passenger keys are not accepted and will return a Bad Request Error.' description: 'GraphQL endpoint: autoAssignSeatsSegment' operationId: nsk_v1_booking_seats_auto_segment_segmentKey_post parameters: - name: segmentKey in: path required: true description: The specific segment key to auto assign. schema: type: string x-position: 1 requestBody: x-name: request description: The auto assign seat request. content: application/json: schema: $ref: '#/components/schemas/AutoAssignRequestv2' required: true x-position: 2 responses: '201': description: Seats auto-assigned. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '207': description: Multi-status. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Partial Failure.: description: Example response of a partially-successful auto-seat assignment. The failed seat assignments will each have a warning message. value: messages: - rawValue: 'Failed to assign seat(s) for passenger ANA MARIA Mateos on the flight VY3212 BCNTFN Detail: Seats cannot be assigned on flight segment VY3212 BCN-TFN for 09/19/2025 due to either one of the following: insufficient number of available seats for 1 passenger (1 total). ' code: FailedToAssignAllSeats debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedToAssignAllSeats value: FailedToAssignAllSeats status: 0 details: failedToAssignAllSeats: 'Failed to assign seat(s) for passenger ANA MARIA Mateos on the flight VY3212 BCNTFN Detail: Seats cannot be assigned on flight segment VY3212 BCN-TFN for 09/19/2025 due to either one of the following: insufficient number of available seats for 1 passenger (1 total). ' data: null /api/nsk/v1/booking/segments/{segmentKey}: delete: tags: - booking/segments summary: Cancels the specific segment from the booking in state. description: 'Calling this method will alter the existing journeyKey. If you are cancelling the only segment in a journey, this method will behave the same as calling DELETE on /api/nsk/v1/booking/journeys/{journeyKey}. If there are segments remaining after the delete, the Location response header will be set with the location of the modified journey with its new key. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: segmentDelete' operationId: nsk_v1_booking_segments_segmentKey_delete parameters: - name: segmentKey in: path required: true description: The key of the specific segment to be canceled. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/segments/{segmentKey}/classOfService: delete: tags: - booking/segments summary: Restores a segment to the class of service prior to an upgrade or downgrade. description: 'This does not truly delete the old class of service. Instead, it restores the original class of service before an upgrade or downgrade occurred. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: classOfServiceResetv2' operationId: nsk_v1_booking_segments_segmentKey_classOfService_delete parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 - name: overSell in: query description: Indicates the intent to restore the class of service even if there are no available AUs. schema: type: boolean nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/segments/{segmentKey}/passengers/{passengerKey}: get: tags: - booking/segments summary: Gets a specific passenger segment from the booking in state. description: 'GraphQL endpoint: passengerSegment' operationId: nsk_v1_booking_segments_segmentKey_passengers_passengerKey_get parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSegment' /api/nsk/v1/booking/segments/{segmentKey}/passengers/{passengerKey}/infant: post: tags: - booking/segments summary: Creates an infant on a passenger in the specified segment. description: 'If the booking in state contains a passive segment, an infant will not be created on the passive segment for the passenger. If the passenger on the specified segment already has an infant, an exception will be thrown. If any other segment in the booking already has an infant, the infant details from the request will be ignored and the infant details from the existing infant will be retained. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: passengerInfantSegmentAdd' operationId: nsk_v1_booking_segments_segmentKey_passengers_passengerKey_infant_post parameters: - name: segmentKey in: path required: true description: The unique segment key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 2 requestBody: x-name: request description: The new infant. content: application/json: schema: $ref: '#/components/schemas/PassengerInfantCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/segments summary: Deletes an infant from a passenger in the specified segment. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: passengerInfantSegmentDelete' operationId: nsk_v1_booking_segments_segmentKey_passengers_passengerKey_infant_delete parameters: - name: segmentKey in: path required: true description: The unique identifier of the segment to remove infants from. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The unique passenger key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/segments/{segmentKey}/passengers/{passengerKey}/tickets: post: tags: - booking/segments summary: Creates a ticket on a passenger segment on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: ticketAdd' operationId: nsk_v1_booking_segments_segmentKey_passengers_passengerKey_tickets_post parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 requestBody: x-name: request description: Details to create the ticket. content: application/json: schema: $ref: '#/components/schemas/TicketRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/segments summary: Updates a ticket on a passenger segment on the booking in state. description: 'If you attempt to update the passenger number and set the ticket indicator code to ''X'' (TicketRequired) you will encounter an error. If you need to update both please do so separately. This endpoint cannot be used to remove a ticket number, but can be used to update to a different ticket number. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: ticketSet' operationId: nsk_v1_booking_segments_segmentKey_passengers_passengerKey_tickets_put parameters: - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 requestBody: x-name: request description: Details to update the ticket. content: application/json: schema: $ref: '#/components/schemas/TicketRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/segments/classOfService/{classModifyKey}: put: tags: - booking/segments summary: Modifies the class of service for the current booking in state to effect a segment upgrade or downgrade. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: classOfServiceModify' operationId: nsk_v1_booking_segments_classOfService_classModifyKey_put parameters: - name: classModifyKey in: path required: true description: The class modify key from class of service availability. schema: type: string x-position: 1 requestBody: x-name: request description: The class modify request. content: application/json: schema: $ref: '#/components/schemas/ClassModifyBaseRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/segments/classOfService/availability: get: tags: - booking/segments summary: Gets class of service availability for the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: classOfServiceAvailabilityv2' operationId: nsk_v1_booking_segments_classOfService_availability_get parameters: - name: isUpgrade in: query description: "Indicates an upgrade class of service request.\nWhen set to\ \ false, indicates a downgrade class of service request.\n " schema: type: boolean x-position: 1 - name: collectedCurrencyCode in: query description: Collected currency code. schema: type: string nullable: true x-position: 2 - name: feePricingMode in: query description: "Fee pricing mode. \nEnumeration values: 0 = MonetaryOnly, 1\ \ = PointsOnly" schema: nullable: true $ref: '#/components/schemas/FeePricingMode' x-position: 3 - name: includeUnavailable in: query description: Indicates that classes of service with no availability should be returned. schema: type: boolean nullable: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfClassAvailability' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/ssrs: get: tags: - booking/ssrs summary: Retrieves the current SSRs added to the booking in state. description: 'Requires a booking in state. GraphQL endpoint: ssrs' operationId: nsk_v1_booking_ssrs_get responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerSsr' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/ssrs: post: tags: - booking/ssrs summary: Adds SSRs to the booking in state. description: 'Adding an SSR by journey automatically adds the SSR to every segment. Requires a booking in state. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: ssrsAddv3' operationId: nsk_v3_booking_ssrs_post requestBody: x-name: request description: The SSR by keys request. content: application/json: schema: $ref: '#/components/schemas/SsrByKeysRequestv2' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/ssrs/{ssrKey}: get: tags: - booking/ssrs summary: Retrieves the current SSR by key. description: 'Requires a booking in state. GraphQL endpoint: ssr' operationId: nsk_v1_booking_ssrs_ssrKey_get parameters: - name: ssrKey in: path required: true description: Unique Ssr passenger identifier. schema: type: string x-position: 1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSsr' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - booking/ssrs summary: Modifies the SSR note. description: 'NOTE: This endpoint takes a singular property for the request body and as such the request will need to be formatted differently than what it typically looks like. For more information, please see https://navitaire-developer-digital-api.azurewebsites.net/articles/Miscellaneous/UniqueInputSingleRequestBodiesREST and the Swagger request examples. Requires a booking in state. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: ssrSet' operationId: nsk_v1_booking_ssrs_ssrKey_put parameters: - name: ssrKey in: path required: true description: Unique Ssr key identifier. schema: type: string x-position: 1 requestBody: x-name: note description: The updated note. content: application/json: schema: type: string examples: Ssr Note, Json Request Body: description: Example request for updating a ssr note. value: Adding an ssr note. required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking/ssrs summary: Deletes the SSR associated with the specified passenger SSR key. description: 'Requires a booking in state. The passenger SSR key can be found in the `PassengerSegment.Ssrs` object in the booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: ssrsDelete' operationId: nsk_v1_booking_ssrs_ssrKey_delete parameters: - name: ssrKey in: path required: true description: The passenger SSR key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v3/booking/ssrs/{ssrKey}: post: tags: - booking/ssrs summary: Add an SSR to the booking in state. description: 'Adding an SSR by journey automatically adds the SSR to every segment. Requires a booking in state. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: ssrAddv3' operationId: nsk_v3_booking_ssrs_ssrKey_post parameters: - name: ssrKey in: path required: true description: The SSR key to add. schema: type: string x-position: 1 requestBody: x-name: request description: The single SSR by key request. content: application/json: schema: $ref: '#/components/schemas/SingleSsrByKeyRequestv2' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Already Booked SSR or Bundle: description: Example OSI Message if passenger already booked an SSR or bundle value: messages: - rawValue: '[HMC] cannot be sold because passenger 0 already booked [THCS] on NV3075 YTZ-LAX.' code: CannotSellBundleSSR debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: CannotSellBundleSSR status: 0 details: cannotSellBundleSSRMessage: '[HMC] cannot be sold because passenger 0 already booked [THCS] on NV3075 YTZ-LAX.' data: null With Cannot Find Interchangeable Bundle SSR: description: Example OSI Message if cannot find interchangeable bundle SSR in state value: messages: - rawValue: Cannot find interchangeable bundle SSR for [HMC] in state. code: CannotSellBundleSSR debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: CannotSellBundleSSR status: 0 details: cannotSellBundleSSRMessage: Cannot find interchangeable bundle SSR for [HMC] in state. data: null With SSR Not Found in Service Bundle: description: Example OSI Message if an SSR is not found in service bundle value: messages: - rawValue: SSR [HMC] not found in service bundle. code: CannotSellBundleSSR debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: CannotSellBundleSSR status: 0 details: cannotSellBundleSSRMessage: SSR [HMC] not found in service bundle. data: null With Duplicate SSR or Bundle: description: Example OSI Message if duplicate SSR or Bundle value: messages: - rawValue: Duplicate SSR [THCS] in SAN-YTZ is not allowed for service bundle. code: CannotSellBundleSSR debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: CannotSellBundleSSR status: 0 details: cannotSellBundleSSRMessage: Duplicate SSR [THCS] in SAN-YTZ is not allowed for service bundle. data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/ssrs/{ssrKey}: delete: tags: - booking/ssrs summary: Deletes the SSR associated with the specified passenger SSR key. description: 'Requires a booking in state. The passenger SSR key can be found in the `PassengerSegment.Ssrs` object in the booking. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: ssrsDeletev2' operationId: nsk_v2_booking_ssrs_ssrKey_delete parameters: - name: ssrKey in: path required: true description: The passenger SSR key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No booking in state: description: No booking loaded into state during the retrieval of SSR availability. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid SSR key: description: The specified SSR key is not valid or not found in the booking. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'ssrKey' with value 'MCFNQ0ZCUkZRLSFRV0VSITEhQk9TIU5WITYzOTEwODM2MDAwMDAwMDAwMCFTTEMhNTY2NyE=' is invalid. type: Validation details: ssrKey: MCFNQ0ZCUkZRLSFRV0VSITEhQk9TIU5WITYzOTEwODM2MDAwMDAwMDAwMCFTTEMhNTY2NyE= rawMessage: The identifier 'ssrKey' with value 'MCFNQ0ZCUkZRLSFRV0VSITEhQk9TIU5WITYzOTEwODM2MDAwMDAwMDAwMCFTTEMhNTY2NyE=' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/booking/ssrs/availability: post: tags: - booking/ssrs summary: Gets the available SSRs that can be added to a booking. description: 'This endpoint requires a booking in state. By default, all SSR availability for the booking is returned. For details about a specific SSR, the `GET booking/passengers/{passengerKey}/ssrs/{ssrCode}/price` endpoint can be used. Duplicate values for trips and/or passenger keys in the request are ignored i.e. only unique values are processed. Infant SSR availability for the configured infant SSR (the infant SSR code recognized by the Digital API on infant-specific endpoints) is included. To determine the configured infant SSR, please use the `GET api/v1/configuration` endpoint. Please note that the SSR key for the configured infant SSR will be null as selling and cancelling the infant SSR is handled by the following infant-specific endpoints: - `POST/DELETE booking/passengers/{passengerKey}/infant` - `POST/DELETE booking/journeys/{journeyKey}/passengers/{passengerKey}/infant` - `POST/DELETE booking/segments/{segmentKey}/passengers/{passengerKey}/infant` - `POST trip/sell` - `POST trip` GraphQL endpoint: ssrAvailabilityv3' operationId: nsk_v3_booking_ssrs_availability_post requestBody: x-name: request description: Optional parameters to filter the SSR availability. content: application/json: schema: $ref: '#/components/schemas/SsrAvailabilityRequestv3' examples: Retrieve SSR availability: description: Example request for retrieving SSR availability. value: trips: - identifier: identifier: '5600' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T00:00:00Z' passengerKeys: - MCFBRFQ- currencyCode: USD feePricingMode: 0 ssrAvailabilityMode: 0 Retrieve SSR availability with multiple trips and passengers: description: Example request for retrieving SSR availability with multiple trips (round-trip, connecting or thru flights) and multiple passengers. value: trips: - identifier: identifier: '5600' carrierCode: NV opSuffix: null destination: DEN origin: SLC departureDate: '2026-07-09T00:00:00Z' - identifier: identifier: '5601' carrierCode: NV opSuffix: null destination: BOS origin: DEN departureDate: '2026-07-09T04:00:00Z' passengerKeys: - MCFBRFQ- - MSFBRFQ- currencyCode: USD feePricingMode: 0 ssrAvailabilityMode: 0 required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSsrAvailability' examples: Get SSR availability: description: Successful retrieval of available SSRs. value: data: journeySsrs: - journeyKey: TlZ_NTYwMH4gfn5TTEN_MTIvMDUvMjAyNSAwNzowMH5CT1N_MTIvMDUvMjAyNSAxMzowMH5_ journeyDetails: identifier: identifier: '5600' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T00:00:00Z' ssrs: - ssrCode: WIFI passengersAvailability: mcfbrfQ-: ssrKey: MCFNQ0ZCUkZRLSFXSUZJITQxIUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 369.97 ssrType: 0 name: Wi-Fi Entertainment Service limitPerPassenger: 1 available: 6 inventoryControlled: true seatDependent: false feeCode: WIFI nest: WIFI seatRestriction: 1 - ssrCode: WCOB passengersAvailability: mcfbrfQ-: ssrKey: MCFNQ0ZCUkZRLSFXQ09CITgzIUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 597.74 ssrType: 0 name: On-Board Wheelchair limitPerPassenger: 1 available: 6 inventoryControlled: true seatDependent: false feeCode: WCOB nest: WCOB seatRestriction: 1 - ssrCode: UNMR passengersAvailability: mcfbrfQ-: ssrKey: MCFNQ0ZCUkZRLSFVTk1SITY4IUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 328.0 ssrType: 0 name: Unaccompanied Minor limitPerPassenger: 1 available: 8 inventoryControlled: true seatDependent: false feeCode: UNMR nest: UNMR seatRestriction: 1 - ssrCode: SURF passengersAvailability: mcfbrfQ-: ssrKey: MCFNQ0ZCUkZRLSFTVVJGITk2IUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 623.61 ssrType: 0 name: Surf Board limitPerPassenger: 1 available: 5 inventoryControlled: true seatDependent: false feeCode: SURF nest: SURF seatRestriction: 1 - ssrCode: SPEQ passengersAvailability: mcfbrfQ-: ssrKey: MCFNQ0ZCUkZRLSFTUEVRITg2IUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 71.27 ssrType: 0 name: Sports Equipment limitPerPassenger: 1 available: 4 inventoryControlled: true seatDependent: false feeCode: SPEQ nest: SPEQ seatRestriction: 1 segmentSsrs: - segmentKey: TlZ_NTYwMH4gfn5TTEN_MTIvMDUvMjAyNSAwNzowMH5CT1N_MTIvMDUvMjAyNSAxMzowMH5_ segmentDetails: identifier: identifier: '5600' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T00:00:00Z' ssrs: - ssrCode: WIFI passengersAvailability: mcfbrfQ-: ssrKey: MCFNQ0ZCUkZRLSFXSUZJITk0IUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 680.66 ssrType: 0 name: Wi-Fi Entertainment Service limitPerPassenger: 1 available: 9 inventoryControlled: true seatDependent: false feeCode: WIFI nest: WIFI seatRestriction: 1 - ssrCode: INFT passengersAvailability: mcfbrfQ-: ssrKey: null passengerKey: MCFBRFQ- price: 100.11 ssrType: 1 name: Infant limitPerPassenger: 1 available: 8 inventoryControlled: true seatDependent: false feeCode: INFT nest: INFT seatRestriction: 1 - ssrCode: INF passengersAvailability: mcfbrfQ-: ssrKey: MSFNQ0ZCUkZRLSFJTkYhMTAhQk9TIU5WITUyNTA4Nzc1Mzg0MjczODc5MDQhU0xDITU2MDAhIA-- passengerKey: MCFBRFQ- price: 38.67 ssrType: 1 name: Infant limitPerPassenger: 1 available: 5 inventoryControlled: true seatDependent: false feeCode: INF nest: INFT seatRestriction: 1 - ssrCode: PETC passengersAvailability: mcfbrfQ-: ssrKey: MCFNQ0ZCUkZRLSFQRVRDITg0IUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 232.34 ssrType: 0 name: Pet in Cabin limitPerPassenger: 1 available: 2 inventoryControlled: true seatDependent: false feeCode: PETC nest: PETC seatRestriction: 1 - ssrCode: BG23 passengersAvailability: mcfbrfQ-: ssrKey: MyFNQ0ZCUkZRLSFCRzIzITcwIUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 855.99 ssrType: 3 name: 23 Kilogram Bag limitPerPassenger: 1 available: 8 inventoryControlled: false seatDependent: false feeCode: BG23 nest: null seatRestriction: 1 - ssrCode: BG15 passengersAvailability: mcfbrfQ-: ssrKey: MyFNQ0ZCUkZRLSFCRzE1ITU2IUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 228.19 ssrType: 3 name: 15 Kilogram Bag limitPerPassenger: 1 available: 3 inventoryControlled: false seatDependent: false feeCode: BG15 nest: null seatRestriction: 1 legSsrs: - legKey: NjM5MDA1MTQ4MDAwMDAwMDAwIU5WITU2MDAhICFTTEMhQk9TITI4NDI3NDk- legDetails: identifier: identifier: '5600' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T00:00:00Z' ssrs: - ssrCode: TLME passengersAvailability: mcfbrfQ-: ssrKey: NCFNQ0ZCUkZRLSFUTE1FITUwIUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 876.23 ssrType: 4 name: Travel Line Meal E limitPerPassenger: 1 available: 2 inventoryControlled: true seatDependent: false feeCode: TLME nest: null seatRestriction: 1 - ssrCode: HMC passengersAvailability: mcfbrfQ-: ssrKey: MiFNQ0ZCUkZRLSFITUMhODghQk9TIU5WITUyNTA4Nzc1Mzg0MjczODc5MDQhU0xDITU2MDAhIA-- passengerKey: MCFBRFQ- price: 511.85 ssrType: 2 name: Hot Meal Combo limitPerPassenger: 1 available: 2 inventoryControlled: true seatDependent: false feeCode: HMC nest: MEAL seatRestriction: 1 - ssrCode: CKML passengersAvailability: mcfbrfQ-: ssrKey: MiFNQ0ZCUkZRLSFDS01MITU2IUJPUyFOViE1MjUwODc3NTM4NDI3Mzg3OTA0IVNMQyE1NjAwISA- passengerKey: MCFBRFQ- price: 415.41 ssrType: 2 name: Standard Chicken Meal limitPerPassenger: 1 available: 6 inventoryControlled: true seatDependent: false feeCode: CKML nest: MEAL seatRestriction: 1 - ssrCode: KRML passengersAvailability: mcfbrfQ-: ssrKey: MiFNQ0ZCUkZRLSFLUk1MITUhQk9TIU5WITUyNTA4Nzc1Mzg0MjczODc5MDQhU0xDITU2MDAhIA-- passengerKey: MCFBRFQ- price: 275.14 ssrType: 2 name: Korean Meal limitPerPassenger: 1 available: 2 inventoryControlled: true seatDependent: false feeCode: KRML nest: MEAL seatRestriction: 1 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No booking in state: description: No booking loaded into state during the retrieval of SSR availability. value: errors: - id: null code: nsk:Booking:NoBookingInState message: nsk:Booking:NoBookingInState type: Validation details: null rawMessage: No booking was found in session, cannot perform operation. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid market: description: The market information specified in the request does not match any segments in the booking in state. value: errors: - id: null code: nsk:Journey:InvalidMarket message: The requested market is not valid. type: Validation details: origin: SLC destination: DEN departureDate: '2026-07-09T00:00:00Z' carrier: NV identifier: '1234' opSuffix: '' rawMessage: The requested market is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid passenger key: description: The passenger key specified in the request is invalid or does not exist in the booking in state. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'PassengerKey' with value 'MSFBRFQ-' is invalid. type: Validation details: passengerKey: MSFBRFQ- rawMessage: The identifier 'PassengerKey' with value 'MSFBRFQ-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid currency code: description: The currency code in the request is not configured or no conversion rate is setup in the system. value: errors: - id: null code: nsk-server:CurrencyConversionRateNotFound message: nsk-server:CurrencyConversionRateNotFound type: Information details: null rawMessage: No currency conversion rate found from XXX to USD. You need to add this rate in Management Application. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v2/booking/ssrs/availability: post: tags: - booking/ssrs summary: Get the ssr's available to add to the booking in state. description: '- Requires a booking in state. - By default, all ssr availability for the booking is returned. - For details about a specific ssr you can use the `/booking/passengers/{passengerKey}/ssrs/{ssrCode}/price` endpoint. - Infant SSR availability for the configured infant SSR is not included by default. - If the configured infant SSR availability needs to be displayed, the `passengerOptions.showInfantSsrAvailability` flag in the API''s configuration should be set to true. - Note that the SSR key for the default, configured infant SSR will be null as selling the infant SSR is handled via the following endpoints: - `booking/passengers/{passengerKey}/infant` POST/DELETE - `trip/sell` POST - `trip` POST GraphQL endpoint: ssrAvailabilityv2' operationId: nsk_v2_booking_ssrs_availability_post requestBody: x-name: request description: Optional request filter. content: application/json: schema: $ref: '#/components/schemas/SsrAvailabilityRequestv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSsrAvailability' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/booking/ssrs/bundles/resell: post: tags: - booking/ssrs summary: Resells any cancelled SSR bundle to the provided journey on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: resellSsrBundles' operationId: nsk_v1_booking_ssrs_bundles_resell_post requestBody: x-name: request description: The bundle resell request. content: application/json: schema: $ref: '#/components/schemas/BundleResellRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/ssrs/manual: delete: tags: - booking/ssrs summary: Deletes the SSR that matches the request criteria. description: 'Requires a booking in state. This is an alternate way of deleting an SSR. It is still recommended to delete an SSR by the passenger key (see DELETE /booking/ssrs/{ssrKey}). This method is useful if the application is not querying availability and not using dynamic SSR information. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: ssrsDeleteManual' operationId: nsk_v1_booking_ssrs_manual_delete requestBody: x-name: request description: The unique passenger SSR information. content: application/json: schema: $ref: '#/components/schemas/PassengerSsrKey' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/ssrs/manual: post: tags: - booking/ssrs summary: Adds SSRs to the booking in state. description: 'Adding an SSR by journey automatically adds the SSR to every segment. Requires a booking in state. This is an alternate way of creating an SSR. Creating by ID is recommended (see /api/booking/ssrs). This method is useful if the UI is not querying availability and not using dynamic SSR information. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: ssrsAddManualv2' operationId: nsk_v2_booking_ssrs_manual_post requestBody: x-name: request description: The request for adding an SSR. content: application/json: schema: $ref: '#/components/schemas/SsrsRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/ssrs/resell: post: tags: - booking/ssrs summary: Resells any cancelled SSRs to the provided journey on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: resellSsrs' operationId: nsk_v1_booking_ssrs_resell_post requestBody: x-name: request description: The resell SSR request. content: application/json: schema: $ref: '#/components/schemas/ResellSsrRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/booking/ssrs/resell: post: tags: - booking/ssrs summary: Resells any cancelled SSRs to the provided journey on the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` Related Endpoints: - `GET /api/nsk/v1/booking/journeys`: Gets the collection of journeys on the booking in state. - `GET /api/nsk/v1/booking/ssrs`: Retrieves the current SSRs added to the booking in state. - `GET /api/nsk/v1/settings/general/codes`: Determines which roles are allowed to waive fees. GraphQL endpoint: resellSsrsv2' operationId: nsk_v2_booking_ssrs_resell_post requestBody: x-name: request description: The resell SSR request v2. content: application/json: schema: $ref: '#/components/schemas/ResellSsrRequestv2' examples: Resell SSRs And Auto Assign Seats: description: Example request for reselling SSRs, and auto-assigning the passengers to new seats. value: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDUvMTMvMjAyNSAxNzozMH5CT1N_MDUvMTMvMjAyNSAyMzozMH5_ resellSsrs: true resellUnitSsrs: 1 waiveSeatFee: true Resell SSRs And Do Not Auto Assign Seats: description: Example request for reselling SSRs, but no auto-assigning of passengers to new seats when reselling seat-dependent SSRs. value: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDUvMTMvMjAyNSAxNzozMH5CT1N_MDUvMTMvMjAyNSAyMzozMH5_ resellSsrs: true resellUnitSsrs: 2 waiveSeatFee: true Do Not Resell Seat-Dependent SSRs: description: Example request for reselling SSRs, but no reselling of seat dependent SSRs. value: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDUvMTMvMjAyNSAxNzozMH5CT1N_MDUvMTMvMjAyNSAyMzozMH5_ resellSsrs: true resellUnitSsrs: 0 waiveSeatFee: true required: true x-position: 1 responses: '201': description: The SSRs are resold after the journey has been cancelled then rebooked. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Resold All SSRs: description: All SSRs are resold for the booking passenger. value: data: null Resold Available SSRs: description: Available SSRs are resold for the booking passenger except some SSRs that are unavailable. value: messages: - rawValue: 'A SSR could not be sold for the following SSR, passenger and flight: SFML|MCFBRFQ-|NV5665 |SLC|BOS|2025-08-21T00:00:00.0000000' code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: SSRIsUnavailable value: null status: 1 details: carrierCode: NV departureDate: "7/9/2026 5:55:13\u202FAM" destination: BOS flightNumber: '5665' origin: SLC passengerKey: MCFBRFQ- ssrCode: SFML data: null Resold Available Seat-Dependent SSRs: description: Available seat-dependent SSRs are resold for the booking passenger except for some seat-dependent SSRs that are unavailable and/or restricted. value: messages: - rawValue: 'Unable to resell the unit SSR DEAF for John Doe on 01/01/2000 SLC-BOS #NV5600' code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedToReinstateSSR value: null status: 1 details: null - rawValue: SSR [2BAG] is not available on any seat on flight NV5667 SLC-BOS for passenger John Doe. code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedSeatSSRValidation value: null status: 1 details: null data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Cannot Resell SSRs: description: The SSRs are not resold due to various reasons such as there are no SSRs in the cancelled journey or the `Sell Seat SSR Before Assignment` booking setting is disabled. value: errors: - id: null code: nsk:Ssrs:CannotResellSsr message: Unable to resell the SSR(s) type: Validation details: null rawMessage: Unable to resell the SSR(s) 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 SSRs Unavailable: description: The SSRs are not resold due to unavailability on the rebooked flight. value: errors: - id: null code: nsk:Ssrs:CannotResellSsr message: Unable to resell the SSR(s) type: Validation details: null rawMessage: Unable to resell the SSR(s) 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. messages: - rawValue: 'A SSR could not be sold for the following SSR, passenger and flight: SFML|MCFBRFQ-|NV5665 |SLC|BOS|2025-08-21T00:00:00.0000000' code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: SSRIsUnavailable value: null status: 1 details: carrierCode: NV departureDate: "7/9/2026 5:55:13\u202FAM" destination: BOS flightNumber: '5665' origin: SLC passengerKey: MCFBRFQ- ssrCode: SFML data: null SSR Code Restricted: description: The SSRs are not resold due to restriction. value: errors: - id: null code: nsk:Ssrs:CannotResellSsr message: Unable to resell the SSR(s) type: Validation details: null rawMessage: Unable to resell the SSR(s) 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. messages: - rawValue: SSR [2BAG] is not available on any seat on flight NV5667 SLC-BOS for passenger John Doe. code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedSeatSSRValidation value: null status: 1 details: null data: null Seat-Dependent SSRs Unavailable: description: The seat-dependent SSRs are not resold due to unavailability on the rebooked flight. value: errors: - id: null code: nsk:Ssrs:CannotResellSsr message: Unable to resell the SSR(s) type: Validation details: null rawMessage: Unable to resell the SSR(s) 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. messages: - rawValue: 'Unable to resell the unit SSR DEAF for John Doe on 01/01/2000 SLC-BOS #NV5600' code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: FailedToReinstateSSR value: null status: 1 details: null data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/booking/status: get: tags: - booking summary: Gets the status of the booking commit and returns the booking. description: 'There are certain booking data that are not saved to state, such as payment attachments. This endpoint will return the booking data so that non persisted information is returned when and only when the status code is 200. This is the only time the data will be available. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingCommitStatusv2' operationId: nsk_v2_booking_status_get responses: '200': description: Ok, booking has processed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '202': description: Accepted, booking is still processing. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/systemCode: put: tags: - booking summary: Updates the system code of the state booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingSystemCodeSet' operationId: nsk_v1_booking_systemCode_put requestBody: x-name: systemCode description: The updated system code. content: application/json: schema: type: string required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - booking summary: Removes the system code of the state booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingSystemCodeDelete' operationId: nsk_v1_booking_systemCode_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/validation: get: tags: - booking summary: Evaluates the booking in state prior to commit or payment processing. description: 'The response indicates the forecasted status that will be applied to the booking during commit and if a held seat warning should be issued. GraphQL endpoint: bookingValidation' operationId: nsk_v1_booking_validation_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingValidationResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/booking/verifiedTravelDocuments/segments/{segmentKey}/passengers/{passengerKey}: post: tags: - booking summary: Adds a new verified travel document to a passenger or the associated infant. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` The following items are required to use this endpoint. Agent permissions. Government Security Drivers need to be enabled under government security configurations. Government Security Drivers need to be configured to approve the given document type. The given document must be a document type approved by customs. The target passenger must be either CheckedIn or Boarded on the target segment. Due to the nature of this endpoint there is no data returned. To confirm successful update you can find an entry in the booking using GET `api/nsk/v1/booking` or view passenger segment information by pulling the booking using GET `/api/nsk/v1/bookings/{recordLocator}` GraphQL endpoint: bookingVerifiedTravelDocumentsAdd' operationId: nsk_v1_booking_verifiedTravelDocuments_segments_segmentKey_passengers_passengerKey_post parameters: - name: segmentKey in: path required: true description: The target segment key. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The target passenger key. schema: type: string x-position: 2 requestBody: x-name: request description: The request for updating verified travel documents on a bookings. content: application/json: schema: $ref: '#/components/schemas/BookingVerifiedTravelDocument' examples: Example verified travel document: description: An example of a basic verified travel document. value: documentTypeCode: P issuedByCode: US isInfant: false required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Segment Key Error: description: Example error when segment key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: segmentKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'SegmentKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Lift Status Error: description: Example error when lift status is invalid. value: errors: - id: null code: nsk:VerifiedTravelDocuments:InvalidLiftStatus message: Updating verified travel documents requires the passenger to have a lift status of checked in or boarded. Lift status for passenger JoKwkYODu4gNYRwNQo is currently Default. type: Validation details: null 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 Invalid Document Type Error: description: Example error when document type is invalid. value: errors: - id: null code: nsk:VerifiedTravelDocuments:InvalidDocumentType message: The document type code 'INVALID' is invalid or inactive. type: Validation details: null 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 Invalid Issued by Code Error: description: Example error when document issued by code is invalid. value: errors: - id: null code: nsk:VerifiedTravelDocuments:InvalidIssuedByCode message: The issued by code 'INVALID' is invalid or inactive. type: Validation details: null 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 /api/nsk/v2/bookings: get: tags: - bookings summary: 'Retrieves the booking from the New Skies server based on the retrieve booking request parameters and any configured booking retrieve strategies. If the booking exists and the search criteria is allowed by one of the configured booking retrieve strategies, the booking will be returned, but not loaded into the web session.' description: 'This endpoint will perform validation using a pre-configured booking retrieve strategy. Custom strategies can be configured in Utilities, and are configurable based on application name. To set up a custom strategy, go to Utilities -> Resource Management. From the "Resource Management" screen, go to Root -> Web -> dotREZ folder. Right-click on the dotREZ folder and select "Add Content". On the "Add Resource" screen, set the "Content Name" to "BookingStrategyManagementConfig". Choose "XML" as the "Type". The "Content Data" will be in JSON, and should look like this: { "strategies" : [{ "applicationName" : "dotREZApi", "allowedStrategies" : [ "firstAndLastName", "email" ] }, { "applicationName" : "Web", "allowedStrategies" : [ "email" ] }, { "applicationName" : "", "allowedStrategies" : [ "lastName" ] }] } The application name can be set when creating a new token. If no application name is given for a token create request, the API will use whatever value is defined in the "dotrez-nsk-common.json" configuration file under the "systemOptions" -> "fallbackApplicationName". If no strategies are configured and no "fallbackApplicationName" is configured, the default strategy will be a booking retrieve based on PNR, first name, and last name. If the same strategy should be used for multiple applications, the last entry in the example above can be set by setting an empty string as the application name, and then listing the allowed strategies to be used. Application specific strategies can still be defined, but if no application specific strategy is found, a list of strategies associated with the blank application name will be used (if one exists in the configuration file). The list of strategies currently includes the following options: firstAndLastName email originAndDepartureDate lastName customerNumber More strategies may be added in the future. GraphQL endpoint: bookingsv2' operationId: nsk_v2_bookings_get parameters: - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: string maxLength: 12 minLength: 0 nullable: true x-position: 1 - name: EmailAddress in: query description: "The email address of a contact.\n " schema: type: string maxLength: 266 minLength: 0 nullable: true x-position: 2 - name: Origin in: query description: "The origin station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 3 - name: FirstName in: query description: "The first name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 4 - name: LastName in: query description: "The last name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 5 - name: CustomerNumber in: query description: "One of the passengers customer numbers applied.\n \ \ " schema: type: string maxLength: 20 minLength: 0 nullable: true x-position: 6 - name: DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:14.160618Z' createdDate: '2026-07-09T05:55:14.1606181Z' expirationDate: '2026-07-12T05:55:14.1606182Z' modifiedDate: '2026-07-09T05:58:14.1606195Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:14.1606231Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:14.1606482Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:14.1606508Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:14.160655+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:14.1606533Z' number: P31322423218 issuedDate: '2025-07-09T05:55:14.1606538Z' gender: 1 dateOfBirth: '2025-07-09T05:55:14.1606541Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:14.1606609Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:14.1606564Z' number: P31322423218 issuedDate: '2016-07-09T05:55:14.1606565Z' gender: 1 dateOfBirth: '2002-07-09T05:55:14.1606566Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:14.1606583Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:14.1606841Z' departure: '2026-07-09T05:55:14.1606842Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:14.1606841Z' departure: '2026-07-09T05:55:14.1606842Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:14.1606638Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:14.1606648Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:14.160665Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:14.1606651Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:14.1606654Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:14.1606702Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:14.160675Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:14.1606765Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:14.1606776Z' actualOnBlockTime: '2026-07-10T05:55:14.1606777Z' actualTouchDownTime: '2026-07-11T05:55:14.1606779Z' airborneTime: '2026-07-10T08:55:14.160678Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:14.1606786Z' estimated: '2026-07-09T05:45:14.1606787Z' standardArrivalTime: '2026-07-10T05:55:14.1606789Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:14.1606841Z' departure: '2026-07-09T05:55:14.1606842Z' legInfo: departureTimeUtc: '2026-07-09T12:55:14Z' arrivalTimeUtc: '2026-07-10T10:55:14Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:14.1606805Z' departureTime: '2026-07-09T05:55:14.1606806Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:14.1606859Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:14.1606882Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:14.1606892Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:14.1606901Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:14.1606917Z' transactionCode: TRANSACTION dcc: rateId: 758db33b-103a-4a34-93b1-90414c788963 currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:14.1607027Z' modifiedDate: '2026-07-09T06:00:14.1607029Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:14.1607073Z' beginLocation: SLC endDate: '2026-07-16T05:55:14.1607074Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:14.1607091Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:14.1607094Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:14.1607145Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:14.1607166Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:14.1607175Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:14.1607186Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:14.1607242Z' modified: '2026-07-09T06:25:14.1607243Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: 46477700-2ba8-48f1-b157-102d3b54871f collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid search criteria: description: The search parameters used did not meet the configured strategy in the Management Console. For more information about setting up the strategies, please refer to the Navitaire Developer Portal. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: Invalid search criteria 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 Validation failed: description: The booking associated with the record locator is not found or the provided search parameters didn't match with the booking. The value for the `rawMessage` might differ depending on the strategy used. Aside from the first and last name, it could be email, customer number, last name or origin and departure date. value: errors: - id: null code: nsk:Booking:GeneralRestriction message: nsk:Booking:GeneralRestriction type: Validation details: null rawMessage: First and last name validation failed exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/bookings/{bookingKey}/history: get: tags: - bookings summary: Gets an itinerary history stateless. description: 'GraphQL endpoint: bookingsHistory' operationId: nsk_v1_bookings_bookingKey_history_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: Event in: query description: "The event that triggered the history entry.\n \n\ Enumeration values: 0 = Unknown, 1 = ConvertedHistory, 2 = FlightTimeChange,\ \ 3 = FlightDesignatorChange, 4 = AssignedSeat, 5 = RemoveSeat, 6 = AddedFlight,\ \ 7 = DeletedFlight, 8 = DeletedPassenger, 9 = NameChange, 10 = GroupNameChange,\ \ 11 = CancelledTicketing, 12 = ScheduleChange, 13 = AddedPayment, 14 =\ \ ServiceFee, 15 = QueuedPnr, 16 = UnqueuedPnr, 17 = DeletedComment, 18\ \ = Divided, 19 = CheckedIn, 20 = CheckedOut, 21 = FareOverride, 22 = AddedBaggage,\ \ 23 = ChangedBaggageWeight, 24 = CheckedBaggage, 25 = RemovedBaggage, 26\ \ = BoardedPassenger, 27 = UnboardedPassenger, 28 = ManualAuthorization,\ \ 29 = ManualDecline, 30 = UndoCancel, 31 = ItinerarySent, 32 = ContactChange,\ \ 33 = SsrAdded, 34 = FlightMoved, 35 = VerifiedDocument, 36 = RemovedVerifiedDocument,\ \ 37 = Promotion, 38 = BookingComment, 39 = CancelledSchedule, 40 = CancelServiceFee,\ \ 41 = OverrideServiceFee, 42 = AddedRecordLocator, 43 = DeletedRecordLocator,\ \ 44 = UpgradeClassOfService, 45 = DowngradeClassOfService, 46 = StandbyPriorityChange,\ \ 47 = AssignedTicketNumber, 48 = DeletedTicketNumber, 49 = ConfirmSegmentStatusCodeChange,\ \ 50 = CodeshareFlightChanged, 51 = PdsCancel, 52 = PdsPending, 53 = PdsConfirm,\ \ 54 = PdsFinalized, 55 = PdsDeclined, 56 = PdsException, 57 = PdsCancelRefused,\ \ 58 = PdsCancelUnsuccessful, 59 = Apps, 60 = InhibitedOverride, 61 = PrintedBagTag,\ \ 62 = SelfPrintedBagTag, 63 = PrintedBoardingPass, 64 = AddCustomerId,\ \ 65 = DeleteCustomerId, 66 = HoldCreated, 67 = HoldRemoved, 68 = HoldChanged,\ \ 69 = OverrideCoupon, 70 = PdsSynchronized, 71 = PdsItemremoved, 72 = Reprice,\ \ 73 = ChannelOverride, 74 = EmdCreated, 75 = EmdRemoved, 76 = EmdChanged,\ \ 77 = ServiceBundle, 78 = PublishedFareOverride, 79 = FareClassRealignment,\ \ 80 = AddedDocument, 81 = ChangedDocument, 82 = DeletedPaymentProperties" schema: nullable: true $ref: '#/components/schemas/BookingHistoryEvent' x-position: 2 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 3 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfHistoryResponse' examples: Retrieve Booking History Stateless Response: description: Example response for successfully retrieving the booking history. value: data: histories: - historyCategory: 30 details: AD P 1234 event: 2 pointOfSale: isoCountryCode: null sourceSystemCode: null agentCode: CCAuserM domainCode: DEF locationCode: HDQ organizationCode: SYSTEM sourcePointOfSale: isoCountryCode: null sourceSystemCode: null agentCode: CCAuserM domainCode: DEF locationCode: HDQ organizationCode: SYSTEM receivedBy: Dailey, Paltry receivedByReference: 801-555-9965 createdDate: '2026-07-09T05:55:13.9045187+00:00' pageKey: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid passenger key error: description: Example error when passenger key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'bookingKey' with value 'ABCDE' is invalid. type: Validation details: bookingKey: ABCDE 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 '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{bookingKey}/history/bagTagPrint: get: tags: - bookings summary: Gets the current bag tag print history for a booking, stateless. description: 'GraphQL endpoint: bookingsBagTagPrintv2' operationId: nsk_v1_bookings_bookingKey_history_bagTagPrint_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: isBagTagSelfPrinted in: query description: Whether the bag tag is self printed. schema: type: boolean nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBagTagPrintHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - bookings summary: Creates a bag tag print history for a booking, stateless. description: 'Also updates bag''s status from Added to AddedPrinted if Self-Tagging Baggage is enabled. In order to see the status of a bag, check bags on a passenger segment. The `Enable Baggage Self-Tagging` in Premium Services and `Write to booking history for bag tag printing` in Departure Control Settings must be enabled in Management Console for self bag-tag printing. GraphQL endpoints: bookingsBagTagPrintHistoryAdd, bookingsBagTagPrintHistoryAddBatch' operationId: nsk_v1_bookings_bookingKey_history_bagTagPrint_post parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The bag tag print history request. content: application/json: schema: $ref: '#/components/schemas/BagTagPrintHistoryRequest' examples: Bag Tag Print History Request: description: Example request for creating a bag tag print history. value: legKey: NjM4NzkzNDMyMDAwMDAwMDAwIU5WITU2MjYhICFTTEMhREVOITMxNDQ0ODk- receivedBy: John Doe passengerName: first: John middle: Cee last: Doe title: MR suffix: null isBagTagSelfPrinted: true bagTagInformation: - osTag: 0888045757 taggedToStation: DEN weight: 15 weightType: 2 originStation: SLC required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Null Leg Key: description: The provided leg key is null. value: errors: - id: 09ef838d-5e7c-a7fa-fcbf-4b3429d4cfe6 code: BagTagPrintHistoryRequest.LegKey:RequiredAttribute message: BagTagPrintHistoryRequest.LegKey:RequiredAttribute type: Validation details: validation: RequiredAttribute model: BagTagPrintHistoryRequest member: LegKey rawMessage: The BagTagPrintHistoryRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Invalid Leg Key: description: The provided leg key is invalid and cannot be decoded correctly. value: errors: - id: cfffb48e-507e-6874-5cbd-a397225ffc9e code: nsk:Booking:InvalidLegKey message: nsk:Booking:InvalidLegKey type: Validation details: null rawMessage: The leg key NjM4NzkzNDMyMDAwMDAwMDAwIU5WITU2MjYhICFTTEMhREVOITMxsNDQ0ODk- is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Invalid Booking Key: description: The provided booking key is invalid and cannot be decoded correctly. value: errors: - id: 90465c09-d169-3619-ac68-ed84ca71392e code: nsk:Exceptions:InvalidKey message: The identifier 'bookingKey' with value 'NDAyMjY2sIVFEUVlGRSFmYWxzZQ--' is invalid. type: Validation details: bookingKey: NDAyMjY2sIVFEUVlGRSFmYWxzZQ-- rawMessage: The identifier 'bookingKey' with value 'NDAyMjY2sIVFEUVlGRSFmYWxzZQ--' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Invalid Baggage Weight: description: The baggage weight is invalid or out of range. value: errors: - id: add3f8a9-237d-040c-3a45-e2708bf44a69 code: BagTagInformation.Weight:RangeAttribute message: BagTagInformation.Weight:RangeAttribute type: Validation details: validation: RangeAttribute model: BagTagInformation member: Weight rawMessage: The field BagTagInformation must be between 0 and 32767. 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. Invalid Baggage Weight Type: description: The baggage weight type is invalid or out of range. value: errors: - id: ffedb436-96be-b87c-f338-f68ff1335fcd code: core:Validation:EnumOutOfRange message: The enum 'WeightType' contains an invalid value of '3'. type: Validation details: value: '3' name: WeightType rawMessage: The enum 'WeightType' contains an invalid value of '3'. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Invalid Origin Station Length: description: The origin station is exceeded the maximum character length. value: errors: - id: e255e91c-96f7-472f-5662-700ea3f1436d code: BagTagInformation.OriginStation:StringLengthAttribute message: The field BagTagInformation must be a string with a minimum length of 3 and a maximum length of 3. type: Validation details: validation: StringLengthAttribute model: BagTagInformation member: OriginStation rawMessage: The field BagTagInformation must be a string with a minimum length of 3 and a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. Invalid Tagged To Station Length: description: The tagged to station exceeded the maximum character length. value: errors: - id: 6aaa4d83-e780-eb34-028f-b6fbc272d0f9 code: BagTagInformation.TaggedToStation:StringLengthAttribute message: The field BagTagInformation must be a string with a minimum length of 3 and a maximum length of 3. type: Validation details: validation: StringLengthAttribute model: BagTagInformation member: TaggedToStation rawMessage: The field BagTagInformation must be a string with a minimum length of 3 and a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v1/bookings/{bookingKey}/history/flightMove: get: tags: - bookings summary: Gets a flight move history stateless. description: 'GraphQL endpoint: bookingsFlightMoveHistory' operationId: nsk_v1_bookings_bookingKey_history_flightMove_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 2 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFlightMoveHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{bookingKey}/history/holdDateChange: get: tags: - bookings summary: Gets the hold date change history records for a booking. description: 'GraphQL endpoint: bookingsHoldDateChangeHistory' operationId: nsk_v1_bookings_bookingKey_history_holdDateChange_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: Event in: query description: "The event that triggered the hold date change history entry.\n\ \ \nEnumeration values: 66 = Created, 67 = Removed, 68 = Changed" schema: nullable: true $ref: '#/components/schemas/HoldDateChangeEvent' x-position: 2 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 3 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfHoldDateChangeHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{bookingKey}/history/itinerarySent: get: tags: - bookings summary: Gets the itinerary sent history records for a booking. description: 'GraphQL endpoint: bookingsItinerarySentHistory' operationId: nsk_v1_bookings_bookingKey_history_itinerarySent_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 2 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfItinerarySentHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{bookingKey}/history/message: get: tags: - bookings summary: Gets a booking's message history, stateless. description: 'GraphQL endpoint: bookingsMessageHistory' operationId: nsk_v1_bookings_bookingKey_history_message_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingMessageHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{bookingKey}/history/notification: get: tags: - bookings summary: Gets the booking notification history, stateless. description: 'GraphQL endpoint: bookingsNotificationHistory' operationId: nsk_v1_bookings_bookingKey_history_notification_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingNotificationHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{bookingKey}/history/seatAssignment: get: tags: - bookings summary: Gets a seat assignment history stateless. description: 'GraphQL endpoint: bookingsSeatAssignmentHistory' operationId: nsk_v1_bookings_bookingKey_history_seatAssignment_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: Event in: query description: "The event that triggered the seat assignment history entry.\n\ \ \nEnumeration values: 4 = AssignedSeat, 5 = RemoveSeat" schema: nullable: true $ref: '#/components/schemas/SeatAssignmentEvent' x-position: 2 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 3 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSeatAssignmentHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{bookingKey}/history/segmentChange: get: tags: - bookings summary: Gets a segment change history stateless. description: 'GraphQL endpoint: bookingsSegmentChangeHistory' operationId: nsk_v1_bookings_bookingKey_history_segmentChange_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 - name: Event in: query description: "The event that triggered the seat assignment history entry.\n\ \ \nEnumeration values: 6 = AddedFlight, 7 = DeletedFlight" schema: nullable: true $ref: '#/components/schemas/SegmentChangeEvent' x-position: 2 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 3 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 responses: '200': description: Ok. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSegmentChangeHistoryResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/bookings/{bookingKey}/queue: post: tags: - bookings summary: Adds a booking to a booking queue. description: 'GraphQL endpoint: bookingsEnqueuev3' operationId: nsk_v3_bookings_bookingKey_queue_post parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The booking queue request v2. content: application/json: schema: $ref: '#/components/schemas/BookingQueueRequestv2' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Enqueue Booking, Queue Code Does Not Exist: description: Example error when trying to add a booking to a queue, and the requested queue code does not exist. value: errors: - id: null code: nsk-server:BookingQueueDoesNotExist message: nsk-server:BookingQueueDoesNotExist type: Information details: null rawMessage: Booking Queue 'ZZZZZ' does not exist in the DB.. 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 Manual Queueing for Queue Code Not Allowed: description: Example error when trying to add a booking to a queue, and manual queueing from that queue is not allowed. value: errors: - id: null code: nsk-server:InvalidSelfServiceRebookingQueuing message: nsk-server:InvalidSelfServiceRebookingQueuing type: Information details: null rawMessage: Manual queuing from a Self-Service Rebooking Booking Queue is not allowed. 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 Booking already in queue: description: Example error when trying to add a booking to a queue, and the booking is already in the target queue. value: errors: - id: null code: nsk-server:BookingAlreadyInQueue message: nsk-server:BookingAlreadyInQueue type: Information details: null rawMessage: 'Booking is already on queue: ''DAPI'', BookingID = 127160, BookingQueueItemID = 0, SegmentKey = ''''.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v2/bookings/{bookingKey}/queue: post: tags: - bookings summary: Adds a booking to a booking queue. description: 'GraphQL endpoint: bookingsEnqueuev2' operationId: nsk_v2_bookings_bookingKey_queue_post parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The booking queue request v2. content: application/json: schema: $ref: '#/components/schemas/BookingQueueRequestv2' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true delete: tags: - bookings summary: Removes a booking from a booking queue. description: 'GraphQL endpoint: bookingsDequeuev2' operationId: nsk_v2_bookings_bookingKey_queue_delete parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The booking queue delete request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueDeleteRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{bookingKey}/queue/history: post: tags: - bookings summary: Gets the booking queue history for a specific booking. description: 'GraphQL endpoint: bookingQueueHistory' operationId: nsk_v1_bookings_bookingKey_queue_history_post parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 requestBody: x-name: request description: The booking queue history request. content: application/json: schema: $ref: '#/components/schemas/BookingQueueHistoryRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingQueueHistory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}: get: tags: - bookings summary: Retrieves a booking itinerary stateless. description: 'This endpoint requires a session token and is agent-only. This is a stateless booking endpoint and `LegInfo` is not returned. This is intentional as New Skies does not query schedule data for this call. If this data is needed, please use the stateful booking retrieval endpoint/graph route to get this information. You can also use GET `/api/nsk/v2/trip/info/legs/simple` to get this information. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. If no booking associated with the record locator is found, an HTTP 404 `NotFound` will be returned. GraphQL endpoint: bookingsByRecordLocator' operationId: nsk_v1_bookings_recordLocator_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 responses: '200': description: OK. The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:13.1329999Z' createdDate: '2026-07-09T05:55:13.1330001Z' expirationDate: '2026-07-12T05:55:13.1330001Z' modifiedDate: '2026-07-09T05:58:13.133001Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:13.1330036Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:13.1330257Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:13.1330272Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:13.1330305+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:13.1330288Z' number: P31322423218 issuedDate: '2025-07-09T05:55:13.1330295Z' gender: 1 dateOfBirth: '2025-07-09T05:55:13.1330297Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:13.1330357Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:13.1330323Z' number: P31322423218 issuedDate: '2016-07-09T05:55:13.1330324Z' gender: 1 dateOfBirth: '2002-07-09T05:55:13.1330325Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:13.1330338Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1330539Z' departure: '2026-07-09T05:55:13.133054Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1330539Z' departure: '2026-07-09T05:55:13.133054Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:13.1330392Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:13.13304Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:13.1330401Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:13.1330404Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:13.1330406Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.1330438Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:13.1330478Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:13.133049Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:13.13305Z' actualOnBlockTime: '2026-07-10T05:55:13.1330501Z' actualTouchDownTime: '2026-07-11T05:55:13.1330502Z' airborneTime: '2026-07-10T08:55:13.1330503Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:13.1330507Z' estimated: '2026-07-09T05:45:13.1330508Z' standardArrivalTime: '2026-07-10T05:55:13.133051Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1330539Z' departure: '2026-07-09T05:55:13.133054Z' legInfo: departureTimeUtc: '2026-07-09T12:55:13Z' arrivalTimeUtc: '2026-07-10T10:55:13Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:13.1330521Z' departureTime: '2026-07-09T05:55:13.1330521Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:13.1330552Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:13.1330572Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:13.1330578Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:13.1330583Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:13.1330593Z' transactionCode: TRANSACTION dcc: rateId: bec19ef4-a914-4a86-93ed-c75209849fca currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:13.1330687Z' modifiedDate: '2026-07-09T06:00:13.1330688Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:13.1330734Z' beginLocation: SLC endDate: '2026-07-16T05:55:13.1330735Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:13.1330746Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:13.133075Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:13.1330794Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:13.1330817Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:13.1330822Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:13.1330829Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:13.1330876Z' modified: '2026-07-09T06:25:13.1330877Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: 142aa3c7-dac9-4a86-9fb4-c7b05987aac4 collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/account: get: tags: - bookings summary: Retrieves the booking account and collections based on the record locator. description: 'This endpoint allows agents to see all of the different payment account transactions for the booking. See related endpoint for non agents: /booking/payments/bookingCredit IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingsAccount' operationId: nsk_v1_bookings_recordLocator_account_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAccount' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - bookings summary: 'Creates the booking account based on the record locator and data in the request.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountAdd' operationId: nsk_v1_bookings_recordLocator_account_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: request description: The create account request. content: application/json: schema: $ref: '#/components/schemas/CreateAccountRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/account/collection: post: tags: - bookings summary: 'Creates a booking account collection and transaction based on the record locator and data in the request.' description: 'This endpoint will create a new account collection and a transaction if no collection exists or no matching collection is found. An account collection is unique based on the transaction code and the expiration date. If a matching collection is found, a transaction for that collection is generated and the account collection will be updated. See /api/nsk/v1/resources/accountTransactionCodes for a list of available account transaction codes. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingsAccountCollectionsAdd' operationId: nsk_v1_bookings_recordLocator_account_collection_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: request description: The create account collection request. content: application/json: schema: $ref: '#/components/schemas/AccountCollectionRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/account/collection/{accountCollectionKey}/transactions: get: tags: - bookings summary: 'Retrieves the booking account collection transactions based on the record locator, the account collection key, and the request data.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountTransactions' operationId: nsk_v1_bookings_recordLocator_account_collection_accountCollectionKey_transactions_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 2 - name: StartTime in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: EndTime in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 4 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 5 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 6 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n \ \ " schema: type: integer format: int64 nullable: true x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTransaction' examples: Retrieve Transactions Response: description: Example response for retrieving transactions. value: data: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3431398Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true post: tags: - bookings summary: 'Creates a booking account collection transaction based on the record locator, the account collection key, and data in the request.' description: 'This endpoint will add a transaction to an existing account collection. If there are no account collections, or the account collection key does not match an existing collection, the request will fail. To add a new credit, see /api/nsk/v1/bookings/{recordLocator}/account/collection. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingsAccountTransactionsAdd' operationId: nsk_v1_bookings_recordLocator_account_collection_accountCollectionKey_transactions_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 2 requestBody: x-name: request description: The create transaction requests. content: application/json: schema: $ref: '#/components/schemas/TransactionRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/{recordLocator}/account/collection/{accountCollectionKey}/transactions: get: tags: - bookings summary: Retrieves the booking account collection transactions based on the record locator, the account collection key, and the request data. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountTransactionsv2' operationId: nsk_v2_bookings_recordLocator_account_collection_accountCollectionKey_transactions_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 2 - name: StartDate in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: EndDate in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 4 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 5 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 6 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: string nullable: true x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedTransactionResponse' examples: Retrieve Transactions Successful: description: Example response for a successful retrieval of transactions. value: data: totalCount: 11085 lastPageKey: MTAw transactions: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3842132Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/bookings/{recordLocator}/account/status: put: tags: - bookings summary: Updates the booking account status. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountStatusSet' operationId: nsk_v1_bookings_recordLocator_account_status_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: status in: query description: "The allowed account status. \nEnumeration values: 0 = Open,\ \ 1 = Closed, 2 = AgencyInactive, 3 = Unknown" schema: $ref: '#/components/schemas/AccountStatus' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/account/transactions: get: tags: - bookings summary: Retrieves all of the transactions for all of the collections for the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountAllTransactions' operationId: nsk_v1_bookings_recordLocator_account_transactions_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: StartTime in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 2 - name: EndTime in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n \ \ " schema: type: integer format: int64 nullable: true x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTransaction' examples: Retrieve Transactions Response: description: Example response for retrieving transactions. value: data: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3463866Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/bookings/{recordLocator}/account/transactions: get: tags: - bookings summary: Retrieves all of the transactions for the booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsAccountAllTransactionsv2' operationId: nsk_v2_bookings_recordLocator_account_transactions_get parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: StartDate in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 2 - name: EndDate in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: string nullable: true x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedTransactionResponse' examples: Retrieve Transactions Successful: description: Example response for a successful retrieval of transactions. value: data: totalCount: 11085 lastPageKey: MTAw transactions: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3828848Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/bookings/{recordLocator}/children: get: tags: - bookings summary: Gets children record locators of a booking not in state. description: 'A booking gets children bookings as a result of a booking divide operation. This endpoint returns a list of children booking record locators. GraphQL endpoint: childrenRecordLocators' operationId: nsk_v1_bookings_recordLocator_children_get parameters: - name: recordLocator in: path required: true description: The record locator to find children bookings for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfString' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/bookings/{recordLocator}/comments: post: tags: - bookings summary: Adds a comment to a booking not in state. description: 'Requires agent permissions. Note: To add comments and log added comments to GDS history please use POST or PUT /api/nsk/v3/booking and set SendToBookingSource to true GDS comments cannot be logged statelessly. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: bookingsCommentsAddv3' operationId: nsk_v3_bookings_recordLocator_comments_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: comments description: The comments to add. content: application/json: schema: type: array items: $ref: '#/components/schemas/BookingsCommentRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/email: post: tags: - bookings summary: Sends itinerary notification via email. description: 'This method will always send itinerary notifications via email, regardless of the chosen distributionOption on the contact. GraphQL endpoint: bookingsAddEmailNotification' operationId: nsk_v1_bookings_recordLocator_email_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/fareOverride/journey/{journeyKey}: post: tags: - bookings summary: Replaces an existing fare price with an amount specified. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsFareOverrideAdd' operationId: nsk_v1_bookings_recordLocator_fareOverride_journey_journeyKey_post parameters: - name: recordLocator in: path required: true description: The booking key. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journeyKey. schema: type: string x-position: 2 requestBody: x-name: request description: The fare override request. content: application/json: schema: $ref: '#/components/schemas/FareOverrideRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/fees/{passengerFeeKey}/confirm: put: tags: - bookings summary: Confirms the passenger fee for a given booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: confirmPassengerFee' operationId: nsk_v1_bookings_recordLocator_fees_passengerFeeKey_confirm_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: passengerFeeKey in: path required: true description: The passenger fee key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/journey: put: tags: - bookings summary: Moves a journey on a stateless booking to a different journey. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsMoveJourney' operationId: nsk_v1_bookings_recordLocator_journey_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: moveJourneyRequest description: The move journey request. content: application/json: schema: $ref: '#/components/schemas/MoveJourneyRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/bookings/{recordLocator}/journey: put: tags: - bookings summary: Moves a journey on a stateless booking to a different journey. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsMoveJourneyv2' operationId: nsk_v2_bookings_recordLocator_journey_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: moveJourneyRequest description: The move journey request. content: application/json: schema: $ref: '#/components/schemas/MoveJourneyRequestv2' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Move request missing journey keys: description: Example error for when the ToJourneyKeys list is null or empty. value: errors: - id: null code: MoveJourneyRequestv2.ToJourneyKeys:RequiredAttribute message: MoveJourneyRequestv2.ToJourneyKeys:RequiredAttribute type: Validation details: validation: RequiredAttribute model: MoveJourneyRequestv2 member: ToJourneyKeys rawMessage: The ToJourneyKeys field is required. It is empty or only contains null values. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid record locator.: description: Example error for when the record locator is not valid. value: errors: - id: null code: nsk:Booking:InvalidRecordLocator message: nsk:Booking:InvalidRecordLocator type: Validation details: null rawMessage: The record locator RCELjpDeUF is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid from journey key.: description: Example error for when the FromJourneyKey is not found on the booking. value: errors: - id: null code: nsk:MoveJourney:InvalidFromJourneyKey message: nsk:MoveJourney:InvalidFromJourneyKey type: Validation details: null rawMessage: The 'FromJourneyKey' 'S5FeljIfcR' was not found on the booking with record locator 'DD5DNE'. Move request cannot be processed. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid to journey key.: description: Example error for when one of the ToJourneyKey values is not a valid journey key. value: errors: - id: null code: nsk:MoveJourney:InvalidToJourneyKey message: nsk:MoveJourney:InvalidToJourneyKey type: Validation details: null rawMessage: The 'ToJourneyKey' '8cuBtL9aZa' does not appear to be a valid journey key. Move request cannot be processed. 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 Move Journey Failed.: description: Example error for when the move request failed for unspecified reasons. Please consult the developer portal for potential reasons for this failure. value: errors: - id: null code: nsk:MoveJourney:MoveJourneyFailed message: Failed to move journey due to the NewSkies move status 'UC'. Please check that request information is correct, and consult documentation for possible error states. type: Validation details: null rawMessage: Failed to move journey due to the NewSkies move status 'UC'. Please check that request information is correct, and consult documentation for possible error states. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/journey/adHocMove: put: tags: - bookings summary: 'Combines a collection of journeys represented by the "ToJourneyKeys" into one journey and attempts to create an ad hoc connection between the journeys, and then move to the new journey.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This endpoint does not validate that the submitted journeys are valid for ad hoc connections. It is the responsibility of the end user to ensure that the ad hoc connection is valid. Submit the journey keys in order in the "ToJourneyKeys" list, with the origin journey appearing first, and the final destination journey appearing last in the list. The segments from each valid journey will be combined in order to create the new journey. GraphQL endpoint: bookingsAdHocMoveJourney' operationId: nsk_v1_bookings_recordLocator_journey_adHocMove_put parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 requestBody: x-name: request description: The ad hoc move journey request. content: application/json: schema: $ref: '#/components/schemas/AdHocMoveJourneyRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Ad hoc move missing journey keys: description: Example error for when the ToJourneyKeys list is null or empty. value: errors: - id: null code: AdHocMoveJourneyRequest.ToJourneyKeys:RequiredAttribute message: AdHocMoveJourneyRequest.ToJourneyKeys:RequiredAttribute type: Validation details: validation: RequiredAttribute model: AdHocMoveJourneyRequest member: ToJourneyKeys rawMessage: The ToJourneyKeys field is required. It is empty or only contains null values. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid record locator.: description: Example error for when the record locator is not valid. value: errors: - id: null code: nsk:Booking:InvalidRecordLocator message: nsk:Booking:InvalidRecordLocator type: Validation details: null rawMessage: The record locator RCELjpDeUF is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid from journey key.: description: Example error for when the FromJourneyKey is not found on the booking. value: errors: - id: null code: nsk:MoveJourney:InvalidFromJourneyKey message: nsk:MoveJourney:InvalidFromJourneyKey type: Validation details: null rawMessage: The 'FromJourneyKey' 'S5FeljIfcR' was not found on the booking with record locator 'DD5DNE'. Move request cannot be processed. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid to journey key.: description: Example error for when one of the ToJourneyKey values is not a valid journey key. value: errors: - id: null code: nsk:MoveJourney:InvalidToJourneyKey message: nsk:MoveJourney:InvalidToJourneyKey type: Validation details: null rawMessage: The 'ToJourneyKey' '8cuBtL9aZa' does not appear to be a valid journey key. Move request cannot be processed. 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 Move Journey Failed.: description: Example error for when the move request failed for unspecified reasons. Please consult the developer portal for potential reasons for this failure. value: errors: - id: null code: nsk:MoveJourney:MoveJourneyFailed message: Failed to move journey due to the NewSkies move status 'UC'. Please check that request information is correct, and consult documentation for possible error states. type: Validation details: null rawMessage: Failed to move journey due to the NewSkies move status 'UC'. Please check that request information is correct, and consult documentation for possible error states. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/{recordLocator}/notification: post: tags: - bookings summary: Sends itinerary notification. description: 'Itinerary will be sent using the method set on the contact''s distributionOption field. GraphQL endpoint: bookingsAddNotificationv2' operationId: nsk_v2_bookings_recordLocator_notification_post parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/bookings/{recordLocator}/passengers/{passengerKey}/documents/check: get: tags: - bookings summary: Gets the document check status for a specific passenger if there are any on a specific booking. description: 'Requires a committed booking in state. Requires document check to be enabled in government security configuration. Performs document check and returns the results as documentCheckStatus. More detailed information is intentionally not provided for security reasons. The designers of the client application will need to determine what to do with the different responses, in most cases the passenger will need to be assisted by an airport agent. For more specific requirements check the following endpoint GET/api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements. For configuration options please contact your CSDM. For full documentation see https://developer.navitaire.com/documentation/dotrez-api/how-to/adc. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: documentCheck' operationId: dcs_v1_bookings_recordLocator_passengers_passengerKey_documents_check_get parameters: - name: recordLocator in: path required: true description: The record locator of the associated booking. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDocumentCheckResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/bookings/{recordLocator}/passengers/{passengerKey}/infant/documents/check: get: tags: - bookings summary: Gets the document check status for a specific passenger's infant if there are any on a specific booking. description: 'Requires a committed booking in state. Requires document check to be enabled in government security configuration. Performs document check and returns the results as documentCheckStatus. More detailed information is intentionally not provided for security reasons. The designers of the client application will need to determine what to do with the different responses, in most cases the passenger will need to be assisted by an airport agent. For more specific requirements check the following endpoint GET/api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements. For configuration options please contact your CSDM. For full documentation see https://developer.navitaire.com/documentation/dotrez-api/how-to/adc. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: infantDocumentCheck' operationId: dcs_v1_bookings_recordLocator_passengers_passengerKey_infant_documents_check_get parameters: - name: recordLocator in: path required: true description: The record locator of the associated booking. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDocumentCheckResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/passengers/{passengerKey}/seats/{unitKey}: post: tags: - bookings summary: 'Agent only. Adds a seat assignment to a specific passenger on a booking.' description: 'Agent only. This endpoint actively checks whether the passenger has a seat. If the passenger does have a seat, it will delete the current seat the passenger occupies and add the requested one. This may result in slightly slower response times. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoints: bookingsSeatAdd, bookingsSeatsAdd' operationId: nsk_v1_bookings_recordLocator_passengers_passengerKey_seats_unitKey_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 - name: unitKey in: path required: true description: The unit key. schema: type: string x-position: 3 requestBody: x-name: request description: The add seat request. content: application/json: schema: $ref: '#/components/schemas/AddUnitStatelessConfig' required: true x-position: 4 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - bookings summary: 'Agent only. Deletes a seat assignment from a specific passenger on a booking.' description: 'Agent only. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoints: bookingsSeatDelete, bookingsSeatsDelete' operationId: nsk_v1_bookings_recordLocator_passengers_passengerKey_seats_unitKey_delete parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: passengerKey in: path required: true description: The passenger key. schema: type: string x-position: 2 - name: unitKey in: path required: true description: The unique unit key. schema: type: string x-position: 3 requestBody: x-name: request description: The delete seat request. content: application/json: schema: $ref: '#/components/schemas/DeleteUnitStatelessConfig' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/{recordLocator}/queues/{queueCode}: post: tags: - bookings summary: Retrieves the details for the booking queues of a specific booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsQueues' operationId: nsk_v1_bookings_recordLocator_queues_queueCode_post parameters: - name: recordLocator in: path required: true description: The record locator. schema: type: string x-position: 1 - name: queueCode in: path required: true description: The queue code. schema: type: string x-position: 2 requestBody: x-name: request description: The booking queue request. content: application/json: schema: $ref: '#/components/schemas/BookingQueuesRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingQueue' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/byBookingId/{bookingId}: get: tags: - bookings summary: Retrieves a booking itinerary stateless. description: 'This endpoint requires a session token and is agent-only. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. If no booking associated with the record locator is found, an HTTP 404 `NotFound` will be returned. GraphQL endpoint: bookingsByBookingId' operationId: nsk_v1_bookings_byBookingId_bookingId_get parameters: - name: bookingId in: path required: true description: The New Skies Booking ID. schema: type: integer format: int64 x-position: 1 responses: '200': description: OK. The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Retrieve booking: description: Successful retrieval of a booking value: data: selfServiceMoveAvailable: false bookingKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- recordLocator: PC6Z4H currencyCode: USD systemCode: SYS groupName: GRP locators: numericRecordLocator: '310530162615' parentRecordLocator: PB5L2S parentId: 0 recordLocators: - recordLocatorKey: NjA4NjQyMjchTlY- recordCode: '60864227' systemDomainCode: MVS owningSystemCode: NV bookingSystemCode: NV interactionPurpose: ML hostedCarrierCode: MK info: status: 2 paidStatus: 1 priceStatus: 2 profileStatus: 1 bookingType: Default channelType: 1 bookedDate: '2026-07-09T05:55:13.1355693Z' createdDate: '2026-07-09T05:55:13.1355695Z' expirationDate: '2026-07-12T05:55:13.1355696Z' modifiedDate: '2026-07-09T05:58:13.1355703Z' modifiedAgentId: 1 createdAgentId: 1 owningCarrierCode: NV changeAllowed: true createdUserKey: MQ-- modifiedUserKey: MQ-- sales: created: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW source: isoCountryCode: LA sourceSystemCode: LA agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW modified: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW typeOfSale: residentCountry: US promotionCode: PROMO fareTypes: - FareType hold: expiration: '2026-07-12T05:55:13.1355724Z' breakdown: balanceDue: 0.0 pointsBalanceDue: 0.0 authorizedBalanceDue: 0.0 totalAmount: 66.44 totalPoints: 0.0 totalToCollect: 66.44 totalPointsToCollect: 0.0 totalCharged: 66.44 passengerTotals: services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF totalCost: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- services: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF specialServices: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF seats: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF upgrades: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF spoilage: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF nameChanges: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF convenience: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF infant: total: 25.0 taxes: 0.0 adjustments: 0.0 charges: - amount: 0.3 code: INFT detail: Infant Fee type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 0.3 ticketCode: INF totalCost: null journeyTotals: totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 journeys: tlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_: journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ totalAmount: 40.0 totalPoints: 0.0 totalTax: 2.44 totalDiscount: 0.0 addOnTotals: car: 1.0 hotel: 0.0 activities: 0.0 receivedBy: receivedBy: Doe, John latestReceivedBy: Doe, John receivedReference: DOE latestReceivedReference: DOE referralCode: REFERRAL contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '98123124123' cultureCode: USD address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com customerNumber: '2050001326' sourceOrganization: WWW distributionOption: 0 notificationPreference: 0 companyName: Company Name name: first: John middle: Cee last: Doe title: MR suffix: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: MTk2MjE1 customerNumber: '2050001326' fees: - type: 9 ssrCode: SSR ssrNumber: 365 paymentNumber: 0 isConfirmed: false isConfirming: false isConfirmingExternal: false code: JSF detail: Fee Details passengerFeeKey: MCEwITk- override: false flightReference: 20250131 NV5670 SLCBOS note: Fee Notes createdDate: '2026-07-09T05:55:13.1355898Z' isProtected: false serviceCharges: - amount: 25.0 code: JSF detail: SLC-BOS type: 23 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 25.0 ticketCode: JSF name: first: John middle: Cee last: Doe title: MR suffix: null passengerTypeCode: ADT discountCode: ADT bags: - identifier: '5670' baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- nonStandard: false type: Backpack osTag: NV3665 osTagDate: '2026-07-09T05:55:13.1355912Z' taggedToStation: BOS stationCode: SLC weight: 5 taggedToCarrierCode: JanSport Backpack weightType: 2 program: code: ADT levelCode: LVL number: '365' infant: fees: [] nationality: US dateOfBirth: '2025-07-09T05:55:13.1355937+00:00' travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: JR nationality: US expirationDate: '2036-07-09T05:55:13.1355925Z' number: P31322423218 issuedDate: '2025-07-09T05:55:13.135593Z' gender: 1 dateOfBirth: '2025-07-09T05:55:13.1355932Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City residentCountry: US gender: 1 name: first: John middle: Cee last: Doe title: MR suffix: JR type: INFT declaredGender: null info: nationality: US residentCountry: US gender: 1 dateOfBirth: '2002-07-09T05:55:13.1355977Z' familyNumber: 1 declaredGender: null travelDocuments: - passengerTravelDocumentKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- documentTypeCode: PASS birthCountry: USA issuedByCode: USA name: first: John middle: Cee last: Doe title: MR suffix: null nationality: US expirationDate: '2036-07-09T05:55:13.1355947Z' number: P31322423218 issuedDate: '2016-07-09T05:55:13.1355948Z' gender: 1 dateOfBirth: '2002-07-09T05:55:13.1355949Z' declaredGender: M placeOfBirth: Salt Lake City placeOfIssue: Salt Lake City addresses: - status: 0 companyName: Company Name lineOne: Line One passengerAddressKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- phone: 801-555-1212 lineTwo: Line Two stationCode: SLC lineThree: Line Three emailAddress: johndoe@gmail.com countryCode: US cultureCode: US provinceState: UT refusedContact: false city: Salt Lake City postalCode: '84101' weightCategory: 1 emdCoupons: - status: 0 passengerEmdCouponKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- emdTypeCode: 0 emdNumber: '1234567890123' couponNumber: 1 optionalServiceInformation: carrierCode: NV reasonForIssuanceSubCode: RFISC salesDate: '2026-07-09T05:55:13.135596Z' flightReference: 20250131 NV5670 SLCBOS receivedFromSystemCode: GDS numberOfServices: 1 feeType: 9 feeKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- ssrCode: SSR ssrNumber: 365 journeys: - flightType: 1 stops: 0 designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1356122Z' departure: '2026-07-09T05:55:13.1356122Z' move: maxMoveBackDays: 365 maxMoveOutDays: 365 segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1356122Z' departure: '2026-07-09T05:55:13.1356122Z' isSeatmapViewable: true fares: - isGoverning: true carrierCode: NV fareKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjB_flg- classOfService: E classType: Class Type fareApplicationType: 0 fareClassOfService: E fareBasisCode: ERPTSFRE fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: E ruleNumber: RPTS productClass: C2 ruleTariff: RPTS travelClassCode: C pricingDate: '2026-07-09T05:55:13.1355997Z' crossReferenceClassOfService: E fareDesignator: fareTypeCodes: - A - AP - B - C passengerFares: - serviceCharges: - amount: 2.44 code: USTAX detail: SLC-BOS type: 5 collectType: 0 currencyCode: USD foreignCurrencyCode: USD foreignAmount: 2.44 ticketCode: US discountCode: ADT fareDiscountCode: 20DDISC ticketFareBasis: null passengerType: ADT fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '5670' carrierCode: NV opSuffix: N passengerSegment: mcfbrfQ-: seats: - compartmentDesignator: C penalty: 0 unitDesignator: 7G seatInformation: deck: 1 seatSet: 1 propertyList: aisle: 'TRUE' bulkhead: 'TRUE' tcc: C arrivalStation: BOS departureStation: SLC passengerKey: MCFBRFQ- unitKey: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9TITdHIUM- crossReferenceSeatingPreference: A isPending: false seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T passengerKey: MCFBRFQ- activityDate: '2026-07-09T05:55:13.1356005Z' boardingSequence: '0' createdDate: '2026-07-09T05:55:13.1356006Z' liftStatus: 0 modifiedDate: '2026-07-09T06:05:13.1356007Z' overBookIndicator: 0 priorityDate: '2026-07-09T05:55:13.1356009Z' timeChanged: false verifiedTravelDocs: null sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW ssrs: - isConfirmed: false isConfirmingUnheld: false note: Note ssrDuration: 2 ssrKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- count: 1 ssrCode: SSR feeCode: JSF inBundle: true passengerKey: MCFBRFQ- ssrDetail: Detail ssrNumber: 365 market: identifier: identifier: '5670' carrierCode: NV opSuffix: N destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.1356038Z' tickets: - ticketNumber: '1234567890123' infantTicketNumber: '1234567890124' ticketIndicator: 1 ticketStatus: 1 passengerKey: MCFBRFQ- bags: - baggageKey: MTU4NjExIVBDNlo0SCFmYWxzZQ-- passengerKey: MCFBRFQ- arrivalStation: BOS status: 0 departureStation: SLC osTag: NV3665 scores: - guestValueCode: GVC score: 100 passengerKey: MCFBRFQ- boardingPassDetail: gateInformation: Gate Information priorityInformation: Priority Information cabinClass: Cabin Class compartmentLevel: Compartment level boardingZone: Boarding Zone seatAssignment: Seat Assignment sequenceNumber: Sequence Number hasInfant: true seatPreferences: seat: 2 travelClass: 2 advancedPreferences: - seatMapCode: AISLE value: 'TRUE' status: 1 bundleCode: CC02 verifiedTravelDocuments: - MTU4NjExIVBDNlo0SCFmYWxzZQ-- referenceNumber: 35642 baggageGroupNumber: 2 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 1 cabinOfService: C externalIdentifier: identifier: '5660' carrierCode: MK opSuffix: M priorityCode: R changeReasonCode: 0 segmentType: 0 salesDate: '2026-07-09T05:55:13.1356068Z' international: false flightReference: 20250131 NV5670 SLCBOS legs: - legKey: NjM4NzM5NDE0MDAwMDAwMDAwIU5WITU2NzAhICFTTEMhQk9TITI0MDYxMDQ- operationsInfo: arrivalGate: estimatedGate: First Gate actualGate: Second Gate estimatedArrivalTime: '2026-07-09T08:55:13.1356079Z' departureGate: estimatedGate: First Gate actualGate: Second Gate actualOffBlockTime: '2026-07-10T05:55:13.1356087Z' actualOnBlockTime: '2026-07-10T05:55:13.1356088Z' actualTouchDownTime: '2026-07-11T05:55:13.135609Z' airborneTime: '2026-07-10T08:55:13.1356091Z' arrivalNote: Arrival Note arrivalStatus: 0 baggageClaim: Baggage Claim departureNote: Departure Note departureStatus: 0 departureTimes: scheduled: '2026-07-09T05:55:13.1356095Z' estimated: '2026-07-09T05:45:13.1356096Z' standardArrivalTime: '2026-07-10T05:55:13.1356098Z' tailNumber: 9V-SKA designator: destination: BOS origin: SLC arrival: '2026-07-10T05:55:13.1356122Z' departure: '2026-07-09T05:55:13.1356122Z' legInfo: departureTimeUtc: '2026-07-09T12:55:13Z' arrivalTimeUtc: '2026-07-10T10:55:13Z' adjustedCapacity: 168 arrivalTerminal: Concourse A arrivalTimeVariant: -300 backMoveDays: 365 capacity: 171 changeOfDirection: false codeShareIndicator: 0 departureTerminal: Concourse B departureTimeVariant: -420 equipmentType: '767' equipmentTypeSuffix: '200' eTicket: false irop: false lid: 168 marketingCode: DJM_3R marketingOverride: false operatedByText: Operated By NV operatingCarrier: NV operatingFlightNumber: '5670' operatingOpSuffix: N outMoveDays: 365 arrivalTime: '2026-07-10T05:55:13.1356108Z' departureTime: '2026-07-09T05:55:13.1356109Z' prbcCode: B767EMDJ scheduleServiceType: S sold: 6 status: 0 subjectToGovtApproval: false nests: - adjustedCapacity: 168 classNest: 8 lid: 168 travelClassCode: C nestType: 0 legClasses: - classNest: 8 classAllotted: 0 classType: C classAuthorizedUnits: 0 classOfService: C classRank: 0 classSold: 0 cnxSold: 0 latestAdvancedReservation: 0 status: 0 thruSold: 0 ssrs: - available: 88 ssrNestCode: 1BAG lid: 168 sold: 100 unitSold: 80 seatmapReference: TlYhNTY3MCEgITYzODczOTQxNDAwMDAwMDAwMCFTTEMhQk9T flightReference: 20250131 NV5670 SLCBOS status: 6 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: - type: 0 text: Comment createdDate: '2026-07-09T05:55:13.1356135Z' pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW commentKey: MASDFASDXCFQ- queues: - code: AQCD subCode: AQBD name: Automation Queue Smoke queueId: 121940 passengerId: 196215 watchListId: 23 note: Booking with balance due of 67.44 type: 15 action: 0 mode: 0 flightReference: 20250131 NV5670 SLCBOS bookingQueueKey: MTIxOTQwIUFRQ0Qh passengerAlternateKey: MTk2MjE1 watchListKey: MjM- history: - historyCategory: 31 details: Assigned Seat event: 4 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW receivedBy: Doe, John receivedByReference: '315231' createdDate: '2026-07-09T05:55:13.1356162Z' payments: - paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx code: VI approvalDate: '2026-07-09T05:55:13.1356168Z' details: accountNumberId: 0 parentPaymentId: 0 accountName: John Doe accountNumber: '5110920006810092' expirationDate: '2030-07-09T05:55:13.1356173Z' text: Payment installments: 0 binRange: 511092 fields: payment Field: Payment Field Value amounts: amount: 67.44 currencyCode: USD collected: 67.44 collectedCurrencyCode: USD quoted: 67.44 quotedCurrencyCode: USD authorizationCode: AUTH authorizationStatus: 4 fundedDate: '2026-07-09T05:55:13.1356183Z' transactionCode: TRANSACTION dcc: rateId: 7cec6a8c-2579-4029-ae4d-b8115ebb856b currencyCode: USD rateValue: 1.0 amount: 67.44 putInState: STATE status: 2 applicable: true threeDSecure: browserUserAgent: TAW3 browserAccept: SYS remoteIpAddress: 192.168.1.1 termUrl: www.bank.com paReq: Payload acsUrl: www.bank.com paRes: Response authResult: Approved cavv: UmFuZG9tIENBVlY= cavvAlgorithm: Encryption eci: '05' xid: SDF235 applicable: true successful: true threeDSecureSessionId: VGhpcyBpcyBhIHJhbmRvbSB0aHJlZSBEIHNlY3VyZSBzZXNzaW9uIElELg== challengePreference: 0 challengeWindowSize: 0 transactionIdThreeDSecure: 6f068cbd-40cc-97d2-e8bc-139591794461 threeDSecureVersion: 1.0.2 merchantData: MerchantData redirectJwt: VGhpcyBpcyBhIHJhbmRvbSByZWRpcmVjdCBKV1QgdG9rZW4gc3RyaW5nLg== redirectJwtUrl: www.bank.com dsTransactionId: SDF235 authenticationStatus: 1 attachments: - id: 365291 paymentId: 3652391231 attachment: AQIDBAU= createdDate: '2026-07-09T05:55:13.135627Z' modifiedDate: '2026-07-09T06:00:13.1356271Z' type: 0 status: 3 transferred: false channelType: 1 pointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW sourcePointOfSale: agentCode: Agent domainCode: TAW3 locationCode: TAW3 organizationCode: WWW deposit: false accountId: 0 voucher: id: 0 transactionId: 0 overrideRestrictions: false overrideAmount: false recordLocator: PC6Z4H addedToState: true createdAgentId: 1 modifiedAgentId: 1 reference: 150509 passengerVoucher: passengerVoucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx passengerKey: MCFBRFQ- voucherConfigurationCode: HNDACAR voucherUses: - 13 customerPrograms: - programCode: HNDA programNumber: '3215135' customerNumber: '2050001326' addOns: honda Civic: paymentRequired: false status: 0 addOnKey: null type: 4 summary: total: 100.0 held: 0.0 charged: 100.0 supplierCode: HONDA beginDate: '2026-07-09T05:55:13.1356305Z' beginLocation: SLC endDate: '2026-07-16T05:55:13.1356306Z' endLocation: BOS externalReference: HONDA-123 description: Car Rental externalConfirmationNumber: HDA365 reference: Component Reference created: agentReference: MTIxNTg- agentCode: Agent date: '2026-07-09T05:55:13.1356314Z' organizationCode: WWW domainCode: TAW3 locationCode: TAW3 source: agentCode: Agent organizationCode: WWW domainCode: TAW3 locationCode: TAW3 declinedText: Declined Component Text cultureCode: US modifiedDate: '2026-07-09T06:55:13.1356318Z' modifiedAgentReference: Agent Reference order: address: coordinates: latitude: '40.7608' longitude: ' -111.951814' lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' orderKey: HNDA365 phoneNumbers: - type: 1 number: '98123124123' active: false locations: - description: Salt Lake City Location code: SLC utcOffset: 365.0 usageDate: '0001-01-01T00:00:00' criteria: catalogCode: A countryCode: US supplierCode: JPN departmentCode: CARS vendorCode: HNDA companyCode: HNDA ratingCode: '10' discountCode: CVCDSC promotionCode: HNDASALE currencyCode: USD categoryCode: CAR customer: customerKey: MCFBRFQ- name: first: John middle: Cee last: Doe title: MR suffix: null customerNumber: '2050001326' address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' dateOfBirth: '2002-07-09T05:55:13.1356352Z' emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 thumbnailFileName: File Name participants: john Doe: participantKey: MCFBRFQ- description: New Participant name: first: John middle: Cee last: Doe title: MR suffix: null participantTypeCode: ADT address: county: Salt Lake County lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' isPrimary: true dateOfBirth: '2002-07-09T05:55:13.1356364Z' document: number: '1' issuedByCode: PRTICPANT documentTypeCode: CHECK emailAddress: johndoe@gmail.com companyName: Company Name type: Residential homePhone: 833-81-21 workPhone: 801-555-1212 fax: 801-555-1212 quantity: 10 history: - code: Y previousCode: N note: Note created: '2026-07-09T05:55:13.1356368Z' hasError: false usageDate: '0001-01-01T00:00:00' payment: paymentKey: MTUwNTA5ITEhQ0EhMTU4NjEx type: VI currencyCode: USD name: first: John middle: Cee last: Doe title: MR suffix: null number: '5110920006810092' expiration: '2030-07-09T05:55:13.1356373Z' cvv: '365' amount: 100.0 description: Payment Description issueNumber: '3656912' address: lineOne: Address Line One lineTwo: Address Line Two lineThree: Address Line Three countryCode: US provinceState: UT city: Salt Lake City postalCode: '84101' emailAddress: johndoe@gmail.com phoneNumbers: - type: 1 number: '98123124123' externalLocator: JPN parameters: - value: '10' code: HNDA description: Parameter Description description: Order Description descriptionFormatType: Description Format Type productDescription: Product Description productVariationDescription: Product Variation Description paymentAction: 1 amounts: display: value: 25.0 total: 50.0 initial: value: 25.0 total: 50.0 markup: value: 25.0 total: 50.0 listed: value: 25.0 total: 50.0 listedDiscount: value: 25.0 total: 50.0 discount: value: 25.0 total: 50.0 handling: value: 25.0 total: 50.0 handlingDiscount: value: 25.0 total: 50.0 dueNow: preTax: 25.0 tax: 10.0 total: 35.0 dueLater: preTax: 25.0 tax: 10.0 total: 35.0 personalizations: 10.0 taxable: 35.0 services: 50.0 fees: 100.0 total: 115.0 taxRate: 2 taxExempt: true taxAtUnitPrice: true terms: - code: APPROVED description: Description terms: Terms cancellationTerms: - code: CANCELLED description: Description terms: Terms details: - code: HNDA styleCode: H description: Description fees: - code: HND feeCategoryCode: VI description: Fee Description amount: value: 25.0 total: 50.0 foreignAmount: value: 25.0 total: 50.0 type: 0 isWaiveable: false foreignCurrencyCode: USD currencyCode: USD isChargeable: false notes: - text: Order Text description: Order Description created: '2026-07-09T05:55:13.1356413Z' modified: '2026-07-09T06:25:13.1356414Z' productVariationKey: HNDA365 productOrderKey: HNDA365 isHistorical: false charges: - type: 6 code: SRVC ticketCode: JSF collection: 0 currencyCode: USD amount: 64.0 details: Charge Details orders: - bookingOrderKey: HNDA365 orderId: ea6529e5-96b9-4b70-b1eb-05cf1955b640 collect: 100.0 thirdPartyCharge: 0.0 thirdPartyHold: 0.0 total: 100.0 status: 1 '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/checkin/{recordLocator}/journey/{journeyKey}: delete: tags: - bookings summary: Removes the checkin status of passengers for a specific journey stateless. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInByJourneyDelete' operationId: nsk_v1_bookings_checkin_recordLocator_journey_journeyKey_delete parameters: - name: recordLocator in: path required: true description: The booking record locator to look up the journey. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 2 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/bookings/checkin/{recordLocator}/journey/{journeyKey}: post: tags: - bookings summary: Checks in a collection of passengers to a specific journey stateless. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` - When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages` is set to true. - When debug mode is disabled, warning and error messages will be returned to agents only if the `SystemOptions.HideErrorMessages` is set to false. GraphQL endpoint: checkInByJourneyv3' operationId: nsk_v3_bookings_checkin_recordLocator_journey_journeyKey_post parameters: - name: recordLocator in: path required: true description: The booking record locator to look up the journey. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key of the journey to check into. schema: type: string x-position: 2 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequestv3' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Check-in Successful: description: Example when check-in is successful. value: data: null Checkin Valid with displaying warning message to agents.: description: Example message when check in requirements are met, but there are still travel documents required. This requires Digital API configuration to be set such that warning messages can be returned to agents only when debug is turned off. value: messages: - code: CheckinPassengerWarning type: Warning value: 'AUT TEST Authorization Response Free Text 8501:AU:OK TO BOARD Documents are required for this flight.' status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null Checkin Valid with a masked warning message.: description: Example message when check in requirements are met, but there are still travel documents required. This is what non-agents will see regardless of Digital API configuration for displaying warning messages when debug is off.This is also what an agent would see if the corresponding API configuration is not set to allow warning messages to be shown. value: messages: - code: CheckinPassengerWarning type: Warning value: CheckinPassengerWarning status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Checkin Invalid: description: Example error when check in requirements are not met. The /requirements endpoint should be called before attempting a checkin. value: errors: - id: null code: nsk:Checkin:Invalid message: nsk:Checkin:Invalid type: Validation details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Checkin request is invalid. Please refer to checkin requirements for more details. 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 Seat Missing: description: In this example the optional request parameter `seatsRequired` was set to true. One passenger had a seat assigned and one did not. value: errors: - id: null code: nsk:Checkin:TypeID:1223 message: nsk:Checkin:TypeID:1223 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Baggins/Bilbo missing seat assignments on flight number 2452. 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 Inhibited: description: In this example the passenger meets all the requirements but is inhibited due to government security. value: errors: - id: null code: nsk:Checkin:TypeID:3096 message: nsk:Checkin:TypeID:3096 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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. - id: null code: nsk:Checkin:TypeID:3088 message: nsk:Checkin:TypeID:3088 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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 Missing verified document with agent visible error message: description: This example shows both the expected response when a passenger is missing verified documents, as well as what a logged-in agent would see if the API configuration is set correctly. This is an example response when debug mode is turned off. value: errors: - id: null code: nsk:Checkin:TypeID:1236 message: Baggins/Bilbo missing verified documents. type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ 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 '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/checkin/{recordLocator}/journey/{journeyKey}/requirements: get: tags: - bookings summary: Gets the checkin pre-validation requirements for a specific journey. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInRequirementsByJourney' operationId: nsk_v1_bookings_checkin_recordLocator_journey_journeyKey_requirements_get parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key to be pre validate checkin with. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirements' examples: Not Paid In Full: description: Example partial response showing that the payment is due before check in value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 4 Closed: description: Example partial response showing that the check in is closed which is common if its outside of the configured check in window. value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 0 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/bookings/checkin/{recordLocator}/journey/{journeyKey}/requirements: get: tags: - bookings summary: Gets the checkin pre-validation requirements for a specific journey version 2. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInRequirementsByJourneyv2' operationId: nsk_v2_bookings_checkin_recordLocator_journey_journeyKey_requirements_get parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key to be pre validate checkin with. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirementsv2' examples: Valid Response No Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: documentsOnFile: - P - V governmentDocumentInstances: - governmentInstance: USDHS numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I - group: 5 documentTypeCode: M verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true - governmentInstance: CBSA numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true isValid: true addressRequirements: isValid: false addressesOnFile: - Address1 unhandledAddresses: - Address2 invalidSsrs: null requiredSsrs: null restrictions: null isValid: true governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 cbsa: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: CBSA messageType: null minVerifiedDocumentCount: 1 restrictions: null isValid: true Response with Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: null addressRequirements: null invalidSsrs: null requiredSsrs: null restrictions: - restriction: 12 description: Missing Documents - restriction: 1 description: Missing Destination Address isValid: false governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 restrictions: - 4 isValid: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/checkin/{recordLocator}/journey/{journeyKey}/status: get: tags: - bookings summary: Gets the passengers lift status stateless for a specific journey based on the record locator. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInStatusByJourney' operationId: nsk_v1_bookings_checkin_recordLocator_journey_journeyKey_status_get parameters: - name: recordLocator in: path required: true description: The record locator in reference to the journey. schema: type: string x-position: 1 - name: journeyKey in: path required: true description: The journey key in reference. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/checkin/{recordLocator}/segment/{segmentKey}: delete: tags: - bookings summary: Removes the checkin status of passengers for a specific journey's segment stateless. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInBySegmentDelete' operationId: nsk_v1_bookings_checkin_recordLocator_segment_segmentKey_delete parameters: - name: recordLocator in: path required: true description: The booking record locator to look up the journeys segment. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 2 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/bookings/checkin/{recordLocator}/segment/{segmentKey}: post: tags: - bookings summary: Checks in a collection of passengers to a specific journeys segment stateless. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` - When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages` is set to true. - When debug mode is disabled, warning and error messages will be returned to agents only if the `SystemOptions.HideErrorMessages` is set to false. GraphQL endpoint: checkInBySegmentv3' operationId: nsk_v3_bookings_checkin_recordLocator_segment_segmentKey_post parameters: - name: recordLocator in: path required: true description: The booking record locator to look up the journeys segment. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key of the segment to check into. schema: type: string x-position: 2 requestBody: x-name: request description: The checkin passengers request. content: application/json: schema: $ref: '#/components/schemas/CheckinPassengersRequestv3' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Check-in Successful: description: Example when check-in is successful. value: data: null Checkin Valid with displaying warning message to agents.: description: Example message when check in requirements are met, but there are still travel documents required. This requires Digital API configuration to be set such that warning messages can be returned to agents only when debug is turned off. value: messages: - code: CheckinPassengerWarning type: Warning value: 'AUT TEST Authorization Response Free Text 8501:AU:OK TO BOARD Documents are required for this flight.' status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null Checkin Valid with a masked warning message.: description: Example message when check in requirements are met, but there are still travel documents required. This is what non-agents will see regardless of Digital API configuration for displaying warning messages when debug is off.This is also what an agent would see if the corresponding API configuration is not set to allow warning messages to be shown. value: messages: - code: CheckinPassengerWarning type: Warning value: CheckinPassengerWarning status: 0 details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_ data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Checkin Invalid: description: Example error when check in requirements are not met. The /requirements endpoint should be called before attempting a checkin. value: errors: - id: null code: nsk:Checkin:Invalid message: nsk:Checkin:Invalid type: Validation details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Checkin request is invalid. Please refer to checkin requirements for more details. 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 Seat Missing: description: In this example the optional request parameter `seatsRequired` was set to true. One passenger had a seat assigned and one did not. value: errors: - id: null code: nsk:Checkin:TypeID:1223 message: nsk:Checkin:TypeID:1223 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: Baggins/Bilbo missing seat assignments on flight number 2452. 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 Inhibited: description: In this example the passenger meets all the requirements but is inhibited due to government security. value: errors: - id: null code: nsk:Checkin:TypeID:3096 message: nsk:Checkin:TypeID:3096 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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. - id: null code: nsk:Checkin:TypeID:3088 message: nsk:Checkin:TypeID:3088 type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n' 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 Missing verified document with agent visible error message: description: This example shows both the expected response when a passenger is missing verified documents, as well as what a logged-in agent would see if the API configuration is set correctly. This is an example response when debug mode is turned off. value: errors: - id: null code: nsk:Checkin:TypeID:1236 message: Baggins/Bilbo missing verified documents. type: Error details: passengerKey: MCFBRFQ- segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_ 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 '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/checkin/{recordLocator}/segment/{segmentKey}/requirements: get: tags: - bookings summary: Gets the checkin pre-validation requirements for a specific bookings journeys segment. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInRequirementsBySegment' operationId: nsk_v1_bookings_checkin_recordLocator_segment_segmentKey_requirements_get parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key to pre validate checkin with. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirements' examples: Not Paid In Full: description: Example partial response showing that the payment is due before check in value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 4 Closed: description: Example partial response showing that the check in is closed which is common if its outside of the configured check in window. value: data: isValid: false passengers: null governmentProgramRequirements: null restrictions: - 0 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/bookings/checkin/{recordLocator}/segment/{segmentKey}/requirements: get: tags: - bookings summary: Gets the checkin pre-validation requirements for a specific bookings journeys segment version 2. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInRequirementsBySegmentv2' operationId: nsk_v2_bookings_checkin_recordLocator_segment_segmentKey_requirements_get parameters: - name: recordLocator in: path required: true description: The record locator of the booking. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key to pre validate checkin with. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckinRequirementsv2' examples: Valid Response No Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: documentsOnFile: - P - V governmentDocumentInstances: - governmentInstance: USDHS numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I - group: 5 documentTypeCode: M verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true - governmentInstance: CBSA numberOfMissingDocuments: 0 eligibleDocuments: - group: 18 documentTypeCode: I verifiableDocuments: - group: 6 documentTypeCode: P - group: 9 documentTypeCode: V documentVerificationRequired: true isValid: true addressRequirements: isValid: false addressesOnFile: - Address1 unhandledAddresses: - Address2 invalidSsrs: null requiredSsrs: null restrictions: null isValid: true governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 cbsa: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: CBSA messageType: null minVerifiedDocumentCount: 1 restrictions: null isValid: true Response with Restrictions: description: Example Response value: data: passengers: passengerKey: passengerKey: PassengerKey documentRequirements: null addressRequirements: null invalidSsrs: null requiredSsrs: null restrictions: - restriction: 12 description: Missing Documents - restriction: 1 description: Missing Destination Address isValid: false governmentProgramRequirements: usdhs: governmentInstance: null requiredDocumentFields: null additionalDataRequired: null programDescription: USDHS messageType: null minVerifiedDocumentCount: 1 restrictions: - 4 isValid: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/checkin/{recordLocator}/segment/{segmentKey}/status: get: tags: - bookings summary: Gets the passengers lift status stateless for a specific segment based on the record locator. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: checkInStatusBySegment' operationId: nsk_v1_bookings_checkin_recordLocator_segment_segmentKey_status_get parameters: - name: recordLocator in: path required: true description: The record locator in reference to the journey. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key in reference. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/queues: post: tags: - bookings summary: Queues the bookings by inventory leg. description: 'GraphQL endpoint: bookingQueuesByInventoryLeg' operationId: nsk_v1_bookings_queues_post requestBody: x-name: request description: The queue booking by inventory leg request content: application/json: schema: $ref: '#/components/schemas/QueueBookingByInventoryLegRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Queued bookings successfully: description: Example when all the bookings are queued successfully. value: data: null Queued with skipped bookings: description: Example when there are bookings skipped during inventory queueing due to unhandled exceptions. value: messages: - code: nsk:BookingQueues:BookingsNotQueued type: Warning value: There are bookings that were not queued. status: 1 details: skippedBookings: ZB3LMA,Y141SB,O232XL data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Leg Key is null or empty: description: Example when the Leg Key is null or empty. value: errors: - id: bef37773-8bc1-0d5e-b407-287277dfee16 code: QueueBookingByInventoryLegRequest.LegKey:RequiredAttribute message: QueueBookingByInventoryLegRequest.LegKey:RequiredAttribute type: Validation details: validation: RequiredAttribute model: QueueBookingByInventoryLegRequest member: LegKey rawMessage: The QueueBookingByInventoryLegRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Booking Queue Codes is null or empty: description: Example when the Booking Queue Codes is null or empty. value: errors: - id: b5b77041-86b5-d75b-5685-03d7d09c7591 code: QueueBookingByInventoryLegRequest.BookingQueueCodes:RequiredAttribute message: QueueBookingByInventoryLegRequest.BookingQueueCodes:RequiredAttribute type: Validation details: validation: RequiredAttribute model: QueueBookingByInventoryLegRequest member: BookingQueueCodes rawMessage: The BookingQueueCodes field is required. It is empty or only contains null values. 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 At least 1 null or empty booking queue code: description: Example if at least one of the Booking Queue Codes is null or empty. value: errors: - id: ff8a93b6-79d0-051e-67eb-1e69fbde1aa9 code: nsk:BookingQueues:BookingQueueCodesNullOrEmpty message: nsk:BookingQueues:BookingQueueCodesNullOrEmpty type: Validation details: null rawMessage: Booking queue codes cannot be null or empty. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Leg Key: description: Example if the Leg Key is not valid. value: errors: - id: 399ce6c5-16f7-9a6a-c234-49bb51e0070c code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: legKey: abc rawMessage: The identifier 'legKey' with value 'abc' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Comments is null or empty: description: Example when the comments is null or empty. value: errors: - id: 0a4856dc-2a3b-b176-b276-5d89b2dbc1da code: QueueBookingByInventoryLegRequest.Comments:RequiredAttribute message: QueueBookingByInventoryLegRequest.Comments:RequiredAttribute type: Validation details: validation: RequiredAttribute model: QueueBookingByInventoryLegRequest member: Comments rawMessage: The QueueBookingByInventoryLegRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inventory Queuing is not allowed: description: Example if queuing bookings on the specified leg is not allowed. value: errors: - id: 35c280c4-26e4-3357-e9f3-c05fd9c3d412 code: nsk:BookingQueues:QueueBookingsOnSpecifiedLegNotAllowed message: nsk:BookingQueues:QueueBookingsOnSpecifiedLegNotAllowed type: Error details: null rawMessage: Queuing bookings on the specified leg is not allowed. 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 Flight is before the allowed time: description: Example if the flight is before the allowed time to process. value: errors: - id: a01958be-bd6c-bdad-ec31-af616b1a0c8b code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected flight is no longer valid for flight queuing. rawMessage: Selected flight is no longer valid for flight queuing. 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 Flight is after the allowed time: description: Example if the flight is after the allowed time to process. value: errors: - id: a01958be-bd6c-bdad-ec31-af616b1a0c8b code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected flight is not yet valid for flight queuing. rawMessage: Selected flight is not yet valid for flight queuing. 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 Flight does not contain any bookings: description: Example if the flight does not contain any bookings value: errors: - id: 741c2461-9eaa-31f8-2868-d43a3aee913e code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected flight does not contain any bookings. rawMessage: Selected flight does not contain any bookings. 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 Booking queue code does not exist: description: Example if a booking queue code in the list does not exist. value: errors: - id: 8b150b05-cbbb-2623-c612-31d6b4650e3f code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected booking queue DAPi is not allowed for flight queuing. rawMessage: Selected booking queue DAPi is not allowed for flight queuing. 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 Booking queue code is not of Inventory Queuing Event Type: description: Example if a booking queue code in the list is not of Inventory Queuing Event Type. value: errors: - id: 9e497521-d2e2-1f2d-3bb8-caa77787db1a code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Selected booking queue AQCD is not allowed for flight queuing. rawMessage: Selected booking queue AQCD is not allowed for flight queuing. 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 Flight does not exist: description: Example if the provided Leg Key has an inexistent flight. value: errors: - id: cef3c8a5-a9d5-21b1-493e-e3fedd7cc18f code: nsk-server:InventoryQueuingNotAllowed message: nsk-server:InventoryQueuingNotAllowed type: Error details: message: Flight does not exist. rawMessage: Flight does not exist. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/bookings/queues/{bookingQueueKey}: delete: tags: - bookings summary: Removes a booking from the specified booking queue item. description: 'GraphQL endpoint: bookingsDequeueByKey' operationId: nsk_v1_bookings_queues_bookingQueueKey_delete parameters: - name: bookingQueueKey in: path required: true description: The unique key of the booking queue to dequeue from. schema: type: string x-position: 1 requestBody: x-name: request description: The request for the dequeue operation. content: application/json: schema: $ref: '#/components/schemas/BookingQueueDeleteByKeyRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/queues/{queueCode}/items: get: tags: - bookings summary: Retrieves the booking queue items associated with the queue code. description: 'GraphQL endpoint: bookingQueueItemsv2' operationId: nsk_v2_bookings_queues_queueCode_items_get parameters: - name: queueCode in: path required: true description: The queue code. schema: type: string x-position: 1 - name: SubQueueCode in: query description: "The sub queue code.\n " schema: type: string nullable: true x-position: 2 - name: StartDate in: query description: "The start date.\n " schema: type: string format: date-time x-position: 3 - name: EndDate in: query description: "The end date.\n " schema: type: string format: date-time x-position: 4 - name: QueueEventType in: query description: "The queue event type.\n \nEnumeration values: 0\ \ = Default, 1 = BookingBalanceDue, 2 = BookingNegativeBalance, 3 = BookingCustomerComment,\ \ 4 = DeclinedPaymentInitial, 5 = DeclinedPaymentChange, 6 = FareOverride,\ \ 7 = ScheduleTimeChange, 8 = ScheduleTimeChangeMisconnect, 9 = ScheduleCancellation,\ \ 10 = FlightDesignatorChange, 11 = ReaccommodationMove, 12 = GdsCancelWithPendingPayment,\ \ 13 = InvalidPriceStatusOverride, 14 = FareRestrictionOverride, 15 = HeldBookings,\ \ 16 = InvalidPriceStatus, 17 = Watchlist, 18 = NonFlightServiceFee, 19\ \ = NotAllTicketNumbersReceived, 20 = BookingSegmentOversold, 21 = ReaccommodationCancel,\ \ 22 = ExternalSsrAutoConfirmed, 23 = OpCarrierSegUpdate, 24 = OpCarrierSsrUpdate,\ \ 25 = OpCarrierOtherUpdate, 26 = NameChangeNotAllowed, 27 = InboundAscNotProcessed,\ \ 28 = OpCarrierInformationChange, 29 = BookingComponentUpdate, 30 = GroupBookings,\ \ 31 = BankDirectPnrOutOfBalance, 32 = NoSeatAssigned, 33 = SeatNumberChange,\ \ 34 = SsrNotSupportedOnNewSeat, 35 = FewerSeatPreferencesMetOnNewSeat,\ \ 36 = AosUnableToConfirmCancel, 37 = ETicketIssue, 38 = ETicketFollowup,\ \ 39 = InvoluntaryFlyAhead, 40 = ManualClearanceOnOutage, 41 = UnbalancedPoints,\ \ 42 = OpCarrierTimeChange, 43 = OaCarrierTimeChange, 44 = VoluntaryFlightChange,\ \ 45 = InvoluntaryFlightChange, 46 = HoldCancellationFailed, 47 = ScheduleTimeChangeWithDynamicQueueCode,\ \ 48 = ReaccommodationMoveWithDynamicQueueCode, 49 = ItineraryIntegrity,\ \ 50 = ReducePartyNotProcessed, 51 = CheckedPassengerUpdate, 52 = MustBeSeatGroupViolation,\ \ 57 = NameChangeWithinRule, 58 = IncompletePassengerEMDCoupon, 59 = ASVCUpdateFailed,\ \ 60 = FailedFareClassRealignment, 61 = ScheduleTimeChangeMisconnectBelowMinimum,\ \ 62 = ScheduleTimeChangeMisconnectAboveMaximum, 63 = OpCarrierMisconnect,\ \ 64 = InventoryQueuing, 65 = SelfServiceAsm, 66 = SelfServiceDelay, 67\ \ = SelfServiceFlightCancellation, 68 = SelfServiceIrop, 69 = SelfServiceScheduleChange,\ \ 70 = SelfServiceTimeChange, 71 = AosAddOrCancelNotSuccessful, 72 = MissingGdsFareFamily,\ \ 73 = ChangeCabinQueue, 74 = PendingPaymentQueue, 75 = TicketDisplayToDetermineIncludedServiceBundleFailed,\ \ 76 = DuplicateTicketsInBooking, 77 = TicketCouponUpdateQueue, 78 = ETicketRefund,\ \ 79 = ExternalEticketVoidCheck, 80 = ExternalEticketVoidCheckFollowUp,\ \ 81 = NoAssignedSeatOnNewFlightFromEquipmentChange" schema: $ref: '#/components/schemas/QueueEventType' x-position: 5 - name: PageSize in: query description: "The number of records to be retrieved per page.\nTo retrieve\ \ the next set of records, use the endpoint again with the lastIndex set.\n\ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 x-position: 6 - name: LastIndex in: query description: "The last row retrieved. This is used for paging.\n \ \ " schema: type: integer format: int64 x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRetrieveBookingQueueResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/quote: post: tags: - bookings summary: Retrieves an itinerary quote based on the request. description: 'Although this endpoint behaves like a GET, POST is used to reduce the limitations resulting from URL length issues. Itinerary is a stateless booking and not tied to the logged-in user. The `IncludeServiceBundle` parameter defaults to `false` if not supplied. GraphQL endpoint: bookingsQuotev2' operationId: nsk_v2_bookings_quote_post requestBody: x-name: request description: The itinerary quote request. content: application/json: schema: $ref: '#/components/schemas/ItineraryQuoteRequest' examples: Basic itinerary quote request: description: Example request for quoting an itinerary with a round-trip flight and a single passenger. value: ssrs: null serviceBundleCodes: null includeServiceBundle: null keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null - journeyKey: TlZ_NTYxM34gfn5CT1N_MDgvMDEvMjAyNSAwNzowMH5TTEN_MDgvMDEvMjAyNSAxMDowMH5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: null promotionCode: null sourceOrganization: null Itinerary quote with infant: description: Example request for quoting an itinerary with a one-way flight and a passenger with infant. value: ssrs: null serviceBundleCodes: null includeServiceBundle: null keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: 1 promotionCode: null sourceOrganization: null Itinerary quote with SSRs: description: Example request for quoting an itinerary with a one-way flight with multiple passengers and SSR. value: ssrs: - market: identifier: identifier: '5622' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2025-07-29T06:00:00' items: - passengerType: ADT ssrs: - ssrCode: BA10 count: 1 designator: null serviceBundleCodes: null includeServiceBundle: null keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 - type: CHD discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: null promotionCode: null sourceOrganization: null Itinerary quote with included bundle: description: Example request for quoting an itinerary with a one-way flight and a passenger with included bundle. For included bundles, if the `includeServiceBundle` is set to `true`, the bundle will be applied regardless if the bundle code is specified in the request or not. value: ssrs: null serviceBundleCodes: null includeServiceBundle: true keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: null promotionCode: null sourceOrganization: null Itinerary quote with add-on bundles: description: Example request for quoting an itinerary with a round-trip flight and a passenger with add-on bundle for both journeys. value: ssrs: null serviceBundleCodes: - DA01 - DA02 includeServiceBundle: true keys: - journeyKey: TlZ_NTYyMn4gfn5TTEN_MDcvMjkvMjAyNSAwNjowMH5CT1N_MDcvMjkvMjAyNSAxNDowMH5ERU5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null - journeyKey: TlZ_NTYxM34gfn5CT1N_MDgvMDEvMjAyNSAwNzowMH5TTEN_MDgvMDEvMjAyNSAxMDowMH5_ fareAvailabilityKey: MH5Ffn5OVn5FUlBUU0ZSRX5SUFRTfn4wfjF_flghMA-- standbyPriorityCode: null inventoryControl: null passengers: types: - type: ADT discountCode: null count: 1 residentCountry: null currencyCode: USD infantCount: null promotionCode: null sourceOrganization: null required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfItineraryQuote' examples: Booking quote successful: description: Example response when the booking quote is successful. value: data: passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: null travelDocuments: null addresses: - status: 0 companyName: null lineOne: 123 First Street passengerAddressKey: null phone: 555-555-1234 lineTwo: null stationCode: SLC lineThree: null emailAddress: null countryCode: US cultureCode: null provinceState: UT refusedContact: null city: SLC postalCode: '84108' weightCategory: null emdCoupons: null journeys: - flightType: 1 stops: 0 designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' move: null segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' isSeatmapViewable: true fares: - isGoverning: true carrierCode: null fareKey: MH5Cfn5OVn5CRU1EfkVTQ1J_fjB_MH5_WA-- classOfService: null classType: null fareApplicationType: 0 fareClassOfService: null fareBasisCode: null fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: null ruleNumber: null productClass: null ruleTariff: null travelClassCode: null pricingDate: '0001-01-01T00:00:00' crossReferenceClassOfService: null fareDesignator: null passengerFares: null fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '1234' carrierCode: NV opSuffix: null passengerSegment: mcfbrfQ-: seats: null passengerKey: null activityDate: null boardingSequence: null createdDate: null liftStatus: 2 modifiedDate: null overBookIndicator: 0 priorityDate: null timeChanged: false verifiedTravelDocs: null sourcePointOfSale: null pointOfSale: null ssrs: - isConfirmed: false isConfirmingUnheld: false note: null ssrDuration: 0 ssrKey: null count: 0 ssrCode: WCHR feeCode: null inBundle: false passengerKey: null ssrDetail: null ssrNumber: null market: null tickets: null bags: null scores: null boardingPassDetail: null hasInfant: false seatPreferences: null bundleCode: null verifiedTravelDocuments: null referenceNumber: 0 baggageGroupNumber: null baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 0 cabinOfService: null externalIdentifier: null priorityCode: null changeReasonCode: 0 segmentType: 0 salesDate: null international: false flightReference: null legs: - legKey: null operationsInfo: null designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' legInfo: null nests: null ssrs: null seatmapReference: null flightReference: null status: 0 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false breakdown: null One or more of the SSRs in the bundle is restricted to the role: description: Example response when one or more of the SSRs in the bundle is restricted to the role. value: messages: - rawValue: Failed to sell SSR HMC in service bundle DA03 on SLC-DEN for passenger 0 code: null debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: CannotSellBundleSSR value: null status: 0 details: null data: passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: null travelDocuments: null addresses: - status: 0 companyName: null lineOne: 123 First Street passengerAddressKey: null phone: 555-555-1234 lineTwo: null stationCode: SLC lineThree: null emailAddress: null countryCode: US cultureCode: null provinceState: UT refusedContact: null city: SLC postalCode: '84108' weightCategory: null emdCoupons: null journeys: - flightType: 1 stops: 0 designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' move: null segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' isSeatmapViewable: true fares: - isGoverning: true carrierCode: null fareKey: MH5Cfn5OVn5CRU1EfkVTQ1J_fjB_MH5_WA-- classOfService: null classType: null fareApplicationType: 0 fareClassOfService: null fareBasisCode: null fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: null ruleNumber: null productClass: null ruleTariff: null travelClassCode: null pricingDate: '0001-01-01T00:00:00' crossReferenceClassOfService: null fareDesignator: null passengerFares: null fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '1234' carrierCode: NV opSuffix: null passengerSegment: mcfbrfQ-: seats: null passengerKey: null activityDate: null boardingSequence: null createdDate: null liftStatus: 2 modifiedDate: null overBookIndicator: 0 priorityDate: null timeChanged: false verifiedTravelDocs: null sourcePointOfSale: null pointOfSale: null ssrs: - isConfirmed: false isConfirmingUnheld: false note: null ssrDuration: 0 ssrKey: null count: 0 ssrCode: WCHR feeCode: null inBundle: false passengerKey: null ssrDetail: null ssrNumber: null market: null tickets: null bags: null scores: null boardingPassDetail: null hasInfant: false seatPreferences: null bundleCode: null verifiedTravelDocuments: null referenceNumber: 0 baggageGroupNumber: null baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 0 cabinOfService: null externalIdentifier: null priorityCode: null changeReasonCode: 0 segmentType: 0 salesDate: null international: false flightReference: null legs: - legKey: null operationsInfo: null designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' legInfo: null nests: null ssrs: null seatmapReference: null flightReference: null status: 0 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false breakdown: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Non-existent currency code: description: The specified currency code is not configured in the system. value: errors: - id: null code: nsk:Validation:UnknownSellCurrencyCode message: nsk:Validation:UnknownSellCurrencyCode type: Validation details: currencyCode: ABC rawMessage: The currency code ABC does not exist or is not active. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Number of passenger exceeds limit: description: The number of passengers specified in the request exceeds what is configured in the Management Console. value: errors: - id: null code: nsk:Availability:MaxBookingPassengers message: nsk:Availability:MaxBookingPassengers type: Validation details: null rawMessage: The requested 101 passengers exceeds the configured system limit of 100. 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 Number of infants is more than the passenger count: description: The number of infants is greater than the number of passengers allowed to have infants on lap. value: errors: - id: null code: nsk:Availability:MaxInfantCountToPassengerCount message: nsk:Availability:MaxInfantCountToPassengerCount type: Error details: null rawMessage: The number of infants 2 requested exceeds the number of allowed passenger types of 1. 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 Non-existent passenger type in the SSRs: description: The passenger type under `ssrs.items` is invalid or not configured in the system. value: errors: - id: null code: nsk:Passenger:InvalidPassengerType message: nsk:Passenger:InvalidPassengerType type: Validation details: null rawMessage: The passenger type XYZ is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Mismatching passenger types in the request: description: The passenger type under `ssrs.items` is not found under `passengers`. value: errors: - id: null code: nsk:Passenger:TypeNotFound message: nsk:Passenger:TypeNotFound type: Error details: null rawMessage: Passenger type SNR is not found in this request. 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 Number of SSRs exceeds limit: description: The SSR count exceeds the allowed number per passenger and leg. value: errors: - id: null code: code=nsk-server:CannotSellSSR message: code=nsk-server:CannotSellSSR type: Validation details: null rawMessage: SSR (BA10) is restricted to 1 occurence(s) per passenger and leg. 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 Bundle is not applicable to the journey or passenger: description: The specified bundle is invalid or ineligible for the journey or passenger. value: errors: - id: null code: nsk-server:ErrorProcessingServiceBundles message: nsk-server:ErrorProcessingServiceBundles type: Information details: null rawMessage: Passenger {name not specified} does not qualify for bundle DAI1 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 Logged-in agent is not authorized to sell the bundle: description: The logged in agent has no permissions to sell the bundle. value: errors: - id: null code: nsk-server:ErrorProcessingServiceBundles message: nsk-server:ErrorProcessingServiceBundles type: Information details: null rawMessage: Current agent is not authorized to sell bundle DA03 exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByAgency: get: tags: - bookings summary: Find booking by agency. description: 'GraphQL endpoint: searchByAgencyv2' operationId: nsk_v2_bookings_searchByAgency_get parameters: - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with\ \ the agent who created\nthe booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 1 - name: FirstName in: query description: "The first name of a passenger.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 2 - name: LastName in: query description: "The last name of a passenger.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 3 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search of the last name.\n \ \ " schema: type: boolean nullable: true x-position: 4 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 6 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 7 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 8 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 9 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 10 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 11 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 12 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 13 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByAgent: get: tags: - bookings summary: Find booking by agent. description: 'GraphQL endpoint: searchByAgentv2' operationId: nsk_v2_bookings_searchByAgent_get parameters: - name: AgentId in: query description: "The agent identifier.\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 1 - name: FirstName in: query description: "The first name of a passenger.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 2 - name: LastName in: query description: "The last name of a passenger.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 3 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search.\n " schema: type: boolean nullable: true x-position: 4 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 6 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 7 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 8 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 9 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 10 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 11 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 12 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 13 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByAgentCode: get: tags: - bookings summary: Find booking by the agent code. description: 'GraphQL endpoint: searchByAgentCodev2' operationId: nsk_v2_bookings_searchByAgentCode_get parameters: - name: AgentCode in: query description: "The agent code (name) that created the booking.\n \ \ " schema: type: string maxLength: 64 minLength: 0 nullable: true x-position: 1 - name: DomainCode in: query description: "The domain code to find.\n " schema: type: string maxLength: 5 minLength: 0 nullable: true x-position: 2 - name: FirstName in: query description: "The first name of a passenger.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 3 - name: LastName in: query description: "The last name of a passenger.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 4 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search.\n " schema: type: boolean nullable: true x-position: 5 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 6 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 7 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 8 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 9 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 10 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 11 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 12 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 13 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 14 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/bookings/searchByBagTag: get: tags: - bookings summary: 'Find booking by a bag tag. The StartUtc needs to be within 7 days before the created date of the booking. If the StartUtc is set to DateTime.MinValue (1/1/0001) or not set at all, the value will be set to the current date, UTC.' description: 'GraphQL endpoint: searchByBagTagv3' operationId: nsk_v3_bookings_searchByBagTag_get parameters: - name: BagTag in: query description: "One of the OS tag number.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 1 - name: StartUtc in: query description: "The OS tag start date. If not set or set to DateTime.MinValue\ \ (1/1/0001), will default to current date, UTC.\nThis date needs to be\ \ within 7 days before the created date of the booking.\n " schema: type: string format: date-time nullable: true x-position: 2 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 4 - name: SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByContact: get: tags: - bookings summary: Find booking by contact. description: 'GraphQL endpoint: searchByContactv2' operationId: nsk_v2_bookings_searchByContact_get parameters: - name: FirstName in: query description: "The first name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 1 - name: LastName in: query description: "The last name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 2 - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: string maxLength: 12 minLength: 0 nullable: true x-position: 3 - name: PhoneNumber in: query description: "One of the applied phone numbers to a passenger or contact.\n\ \ " schema: type: string maxLength: 20 minLength: 0 nullable: true x-position: 4 - name: EmailAddress in: query description: "The email address of a contact.\n " schema: type: string maxLength: 266 minLength: 0 nullable: true x-position: 5 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 6 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with\ \ the agent who created\nthe booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 7 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 8 - name: SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 9 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 10 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 11 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByContactCustomerNumber: get: tags: - bookings summary: Find booking by contact customer number. description: 'GraphQL endpoint: searchByContactCustomerNumberv2' operationId: nsk_v2_bookings_searchByContactCustomerNumber_get parameters: - name: ContactCustomerNumber in: query description: "One of the contacts customer number applied.\n " schema: type: string maxLength: 20 minLength: 1 nullable: true x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 2 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with\ \ the agent who created\nthe booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/searchByCreditCard: post: tags: - bookings summary: Find booking by credit card number. description: 'This endpoint behaves like a GET but is masked as a POST. GraphQL endpoint: searchByCreditCardv2' operationId: nsk_v1_bookings_searchByCreditCard_post requestBody: x-name: request description: Search bookings by credit card request. content: application/json: schema: $ref: '#/components/schemas/SearchBookingsByCreditCard' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByCustomerNumber: get: tags: - bookings summary: Find booking by customer number. description: 'GraphQL endpoint: searchByCustomerNumberv2' operationId: nsk_v2_bookings_searchByCustomerNumber_get parameters: - name: CustomerNumber in: query description: "One of the contacts customer number applied.\n " schema: type: string maxLength: 20 minLength: 1 nullable: true x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 2 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with\ \ the agent who created\nthe booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByDate: get: tags: - bookings summary: Find booking by date. description: 'GraphQL endpoint: searchByDatev2' operationId: nsk_v2_bookings_searchByDate_get parameters: - name: StartDateUtc in: query description: "The booking date start search.\n " schema: type: string format: date-time nullable: true x-position: 1 - name: EndDateUtc in: query description: "The booking date end search.\n " schema: type: string format: date-time nullable: true x-position: 2 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 4 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 5 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 6 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 7 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 8 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 9 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 10 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 11 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByDocument: get: tags: - bookings summary: Find booking by document. description: 'GraphQL endpoint: searchByDocumentv2' operationId: nsk_v2_bookings_searchByDocument_get parameters: - name: Document.DocumentNumber in: query description: "One of the passengers applied travel document number.\n \ \ " schema: type: string maxLength: 35 minLength: 0 nullable: true x-position: 1 - name: Document.DocumentTypeCode in: query description: "One of the passengers applied travel document type code.\n \ \ " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 2 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 4 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 5 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 6 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 7 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 8 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 9 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 10 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 11 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByEmail: get: tags: - bookings summary: Find booking by email. description: 'GraphQL endpoint: searchByEmailv2' operationId: nsk_v2_bookings_searchByEmail_get parameters: - name: EmailAddress in: query description: "The email address of a contact.\n " schema: type: string format: email nullable: true x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 2 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search.\n " schema: type: boolean nullable: true x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/searchByExternalPayment: get: tags: - bookings summary: 'Used to search the list of bookings that have used the account from the payment. Only External Payments should be used for searching.' description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: searchByExternalPayment' operationId: nsk_v1_bookings_searchByExternalPayment_get parameters: - name: RecordLocator in: query description: "The record locator of a booking.\n " schema: type: string nullable: true x-position: 1 - name: PaymentKey in: query description: "The payment key of a specific payment under a booking.\n \ \ " schema: type: string nullable: true x-position: 2 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 4 - name: FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 5 - name: DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 6 - name: Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 7 - name: Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 8 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 9 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 10 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByLastName: get: tags: - bookings summary: Find booking by last name. description: 'GraphQL endpoint: searchByLastNamev2' operationId: nsk_v2_bookings_searchByLastName_get parameters: - name: LastName in: query description: "The last name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 1 - name: FirstName in: query description: "The first name of a passenger or contact.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 2 - name: PhoneticSearch in: query description: "Whether or not to do a phonetic search.\n " schema: type: boolean nullable: true x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/searchByPerson: get: tags: - bookings summary: Retrieves the bookings of the specified person based on the date range. description: 'Adds the ability to search by a date range. To get more information about each booking, a subsequent call to GET /api/nsk/v1/bookings/{recordLocator} can be used. Please use this call and not any stateful calls for performance reasons. GraphQL endpoint: searchByPerson' operationId: nsk_v1_bookings_searchByPerson_get parameters: - name: PersonKey in: query description: "The unique person key. This can be found by using GET /api/nsk/v2/persons\ \ endpoint.\n " schema: type: string maxLength: 100 nullable: true x-position: 1 - name: StartDate in: query description: "The booking date start search. If not set manually the start\ \ date will be set to the current day.\n " schema: type: string format: date-time nullable: true x-position: 2 - name: EndDate in: query description: "The booking date end search. If not set manually the end date\ \ will be 24 hours after the start date.\n " schema: type: string format: date-time nullable: true x-position: 3 - name: PageSize in: query description: "Used to specify the maximum results to return.\nDefaults to\ \ 1000 if not specified. Minimum is 10 and maximum is 5000.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: LastPageKey in: query description: "The last page key of the last paged item. This can be found\ \ on the\nresponse from the previous set of paged results.\n " schema: type: string maxLength: 100 nullable: true x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedBookingSearchByPersonResult' examples: With matching bookings: description: Successful retrieval of bookings that match the search criteria. value: data: bookings: - bookingDate: '2026-07-09T05:55:16.0450106Z' departureDate: '2026-07-12T05:55:16.0450407+00:00' arrivalStation: YTZ departureStation: LAX recordLocator: Z378SY bookingKey: MzY3MTc0IVozNzhTWSE- lastPageKey: MA-- With no matching bookings: description: No bookings match the search criteria. value: data: bookings: [] lastPageKey: MA-- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'asdf' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Customer Number: description: The customer number does not exist. value: errors: - id: 88ab2c3c-bbb4-6788-8gb5-3cg50c2d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'asdf' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Page Size: description: The page size value is not between the range of 10 and 5000. value: errors: - id: 41fa77a0-f351-5152-305f-f92cf1daf8c1 code: SearchBookingsByPerson.PageSize:RangeAttribute message: The field PersonBookingSearchRequest must be between 10 and 5000. type: Validation details: null rawMessage: The field SearchBookingsByPerson must be between 10 and 5000. 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. With Invalid Date Range: description: The date range exceeded the configured maxmimum number of days. value: errors: - id: cc25dafa-5637-2fff-e402-3250131e12ab code: nsk:Booking:MaxBookingSearchDateRange message: nsk:Booking:MaxBookingSearchDateRange type: Validation details: null rawMessage: The requested date range of 764 days exceeds the system limit of 731. 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. With End Date Before Start Date: description: The end date exceeded the start date value: errors: - id: bc4eeb6c-ed73-6a63-f34f-e66bd9c461cb code: FindCustomerBookingRequest.EndDate:MinMaxDateTimeAttribute message: End date may not be before Start date. type: Validation details: null rawMessage: End date may not be before Start date. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v2/bookings/searchByPhone: get: tags: - bookings summary: Find booking by phone. description: 'GraphQL endpoint: searchByPhonev2' operationId: nsk_v2_bookings_searchByPhone_get parameters: - name: PhoneNumber in: query description: "One of the applied phone numbers to a passenger or contact.\n\ \ " schema: type: string maxLength: 20 minLength: 0 nullable: true x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 2 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with\ \ the agent who created\nthe booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 3 - name: Filters.PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: Filters.LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 5 - name: Filters.FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 6 - name: Filters.DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 7 - name: Filters.Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 8 - name: Filters.Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 9 - name: Filters.SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 10 - name: Filters.OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 11 - name: Filters.SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 12 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByRecordLocator: get: tags: - bookings summary: Find booking by record locator. description: 'GraphQL endpoint: searchByRecordLocatorv2' operationId: nsk_v2_bookings_searchByRecordLocator_get parameters: - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: string maxLength: 12 minLength: 0 nullable: true x-position: 1 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 2 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 3 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 4 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 5 - name: SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/bookings/searchByReferenceNumber: get: tags: - bookings summary: 'Find booking by reference number. The reference number is used as identifier by New Skies Rail customers for purposes of ticketing and check in.' description: 'GraphQL endpoint: searchByReferenceNumberv2' operationId: nsk_v2_bookings_searchByReferenceNumber_get parameters: - name: ReferenceNumber in: query description: "The reference number, used as an identifier by New Skies Rail\ \ customers for purposes\nof ticketing and check in.\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 2 - name: OrganizationCode in: query description: "The organization code associated with the agent who created\ \ the booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 3 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 5 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 6 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 7 - name: SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 8 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/bookings/searchByThirdPartyRecordLocator: get: tags: - bookings summary: Find booking by a third party record locator. description: 'GraphQL endpoint: searchByThirdPartyRecordLocatorv3' operationId: nsk_v3_bookings_searchByThirdPartyRecordLocator_get parameters: - name: SystemCode in: query description: "The system code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 1 - name: AgentId in: query description: "The agent identifier.\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 2 - name: OrganizationCode in: query description: "OrganizationCode represents the organization associated with\ \ the agent who created\nthe booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 3 - name: RecordLocator in: query description: "Record locator being requested.\n " schema: type: string maxLength: 12 minLength: 0 nullable: true x-position: 4 - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 6 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 7 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 8 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bookings/watchList/{bookingKey}: get: tags: - bookings summary: Retrieves the watch list for a specific booking. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: bookingsWatchList' operationId: nsk_v1_bookings_watchList_bookingKey_get parameters: - name: bookingKey in: path required: true description: The booking key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfWatchListResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/bundles/applications/{bundleApplicationKey}/details: get: tags: - bundles summary: Retrieves a specific bundle application's details. description: 'See api/nsk/v1/resources/bundles/applications to retrieve the collection of bundle application resources. GraphQL endpoint: bundleApplicationDetails' operationId: nsk_v1_bundles_applications_bundleApplicationKey_details_get parameters: - name: bundleApplicationKey in: path required: true description: The bundle application key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBundleApplicationDetails' /api/nsk/v1/bundles/rules/{bundleRuleCode}/details: get: tags: - bundles summary: 'Retrieves the list of bundle applications associated with the bundle rule.' description: 'See api/nsk/v1/resources/bundles/rules to retrieve the collection of bundle rule resources. GraphQL endpoint: bundleRuleDetails' operationId: nsk_v1_bundles_rules_bundleRuleCode_details_get parameters: - name: bundleRuleCode in: path required: true description: The bundle rule code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleApplication' /api/nsk/v1/bundles/sets/{bundleSetCode}/details: get: tags: - bundles summary: Retrieves the list of bundle codes associated with the bundle set. description: 'See api/nsk/v1/resources/bundles/sets to retrieve the collection of bundle set resources. GraphQL endpoint: bundleSetDetails' operationId: nsk_v1_bundles_sets_bundleSetCode_details_get parameters: - name: bundleSetCode in: path required: true description: The bundle set code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBundleSetDetails' /api/nsk/v1/collection/{accountCollectionKey}/expirationDate: put: tags: - collection summary: 'Updates the expiration of the account collection based on the account collection key and data in the request.' description: 'GraphQL endpoint: accountCollectionExpirationDateSet' operationId: nsk_v1_collection_accountCollectionKey_expirationDate_put parameters: - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 1 requestBody: x-name: request description: The account expiration update request. content: application/json: schema: $ref: '#/components/schemas/AccountExpirationUpdateRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/collection/{accountCollectionKey}/transactions: get: tags: - collection summary: 'Retrieves the credit transactions based on the account collection key and the request data.' description: 'GraphQL endpoint: accountCollectionTransactions' operationId: nsk_v1_collection_accountCollectionKey_transactions_get parameters: - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 1 - name: StartTime in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 2 - name: EndTime in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n \ \ " schema: type: integer format: int64 nullable: true x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTransaction' examples: Retrieve Transactions Response: description: Example response for retrieving transactions. value: data: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3117608Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. 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 deprecated: true /api/nsk/v2/collection/{accountCollectionKey}/transactions: get: tags: - collection summary: 'Retrieves the credit transactions based on the account collection key and the request data.' description: 'GraphQL endpoint: accountCollectionTransactionsv2' operationId: nsk_v2_collection_accountCollectionKey_transactions_get parameters: - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 1 - name: StartDate in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 2 - name: EndDate in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: string nullable: true x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedTransactionResponse' examples: Retrieve Transactions Successful: description: Example response for a successful retrieval of transactions. value: data: totalCount: 11085 lastPageKey: MTAw transactions: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3798047Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/v1/configuration: get: tags: - configuration summary: Retrieves the Digital API configuration. description: 'This is a server-based configuration of the Digital API. For requests to change the configuration, please log a support ticket.' operationId: v1_configuration_get responses: '200': description: The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfApiConfiguration' examples: Retrieve API configuration: description: Successful retrieval of the Digital API configuration. value: data: passengerOptions: infantSsrCode: INFT '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/contacts/searchByPhoneNumber: get: tags: - contacts summary: Gets the latest contact in a booking with a specific phone number. description: 'GraphQL endpoint: contactsByPhoneNumber' operationId: nsk_v1_contacts_searchByPhoneNumber_get parameters: - name: PhoneNumber in: query description: "The phone number.\n " schema: type: string maxLength: 20 minLength: 4 nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfContact' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/contents/news: get: tags: - contents summary: Retrieves the available news metadata. description: "News or sometimes referred to as FYI Content notes are created\ \ by management about your carrier operations. They can be viewed by reservation\ \ agents and station agents.\n\nNews notes are a quick way for airlines to\ \ distribute important information to reservation and check-in agents.\n\n\ If your carrier has a new fare rule, you can use FYI Content to enter this\ \ information and set the FYI type to specify how and when this information\ \ is displayed.You can also determine who reads this information by assigning\ \ roles to it. \n\nYou can also use news content to store pertinent station\ \ info, such as passenger disruption reports or journal entries. By saving\ \ the content as type No Alert, you leave it in the database, where other\ \ users can access it with a search.You can group station reports by Domain,\ \ Department, Role, Date, Name, and so on.\n\nRelated endpoints:\n- `GET /resources/contents`\ \ which contents generic data for all content types including new contents\n\ - `GET /resources/contents/{contentID}/data` which allows you to view the\ \ data for a specific content item including news content.\n\nThe `StartDate`\ \ and `EndDate` will default to the current date if not provided.\n\nThe data\ \ is only returned if the content data type is text based. Other content data\ \ types such as `JPEG` or `PNG` will be returned as null.\n\nGraphQL endpoint:\ \ news" operationId: nsk_v1_contents_news_get parameters: - name: PageSize in: query description: "The number of items to return for this request. Defaults to\ \ the minimum value of 10. The max value is 20.\n " schema: type: integer maximum: 20.0 minimum: 10.0 nullable: true x-position: 1 - name: LastPageKey in: query description: "The LastPageKey, where to start paged query.\n " schema: type: string maxLength: 100 minLength: 0 nullable: true x-position: 2 - name: StartDate in: query description: "The start effective date. This will default to today if not\ \ provided.\n " schema: type: string format: date-time x-position: 3 - name: EndDate in: query description: "The end effective date. This will default to today if not provided.\n\ \ " schema: type: string format: date-time x-position: 4 - name: Type in: query description: "The news type to search.\n \nEnumeration values:\ \ 0 = All, 1 = Alert, 2 = OneTimeRead, 3 = Daily, 4 = NoAlert" schema: $ref: '#/components/schemas/FindNewsType' x-position: 5 - name: RequestType in: query description: "The news request type.\n \nEnumeration values: 0\ \ = Default, 1 = Unread, 2 = UnreadAlert, 3 = UnreadDailyAndOneTimeRead" schema: $ref: '#/components/schemas/NewsRequestType' x-position: 6 - name: DomainCode in: query description: "The domain code. See /resources/Domains for the valid codes.\n\ \ " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 7 - name: DepartmentCode in: query description: "The department code. See /resources/Departments for the valid\ \ codes.\n " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 8 - name: RoleCode in: query description: "The role code. See /resources/Roles for the valid codes.\n \ \ " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 9 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedFindNewsResponse' examples: News retrieved successfully: description: Example when news are retrieved successfully. value: data: newsList: - data: test 1 contentId: 100 name: test1 description: description1 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 1 size: 6 type: 1 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data: "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\\ f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n\\viewkind4\\\ uc1\\pard\\f0\\fs17 TEST 2\\par\r\n}\r\n" contentId: 101 name: test2 description: description2 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 2 size: 138 type: 2 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data: null contentId: 102 name: test3 description: description3 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 3 size: 138 type: 3 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data: null contentId: 103 name: test4 description: description4 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 4 size: 138 type: 4 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data: null contentId: 104 name: test5 description: description5 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 5 size: 138 type: 1 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data: null contentId: 105 name: test6 description: description6 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 6 size: 138 type: 2 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data: null contentId: 106 name: test7 description: description7 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 7 size: 138 type: 3 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data:

Digital API HTML Heading

If you are reading this correctly, it means that the news content is successfully created.

contentId: 107 name: test8 description: description8 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 8 size: 171 type: 4 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data: null contentId: 108 name: test9 description: description9 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 9 size: 138 type: 1 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data: https://www.navitaire.com contentId: 109 name: test10 description: description10 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 10 size: 10 type: 2 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' - data: null contentId: 110 name: test11 description: description11 createdUserKey: MQ-- createdDate: '2024-12-02T05:01:50.2+00:00' dataType: 11 size: 138 type: 3 organizationCode: SYSTEM domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-12-02T00:00:00' discontinueDate: '2024-12-03T00:00:00' retentionDate: '2024-12-04T00:00:00' totalCount: 11 lastPageKey: MTAwMA-- No matching news item: description: Example when no news items match the search criteria. value: data: newsList: [] totalCount: 0 lastPageKey: MTAwMA-- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Retrieving news is not allowed: description: Example when retrieving news is not allowed. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:RetrieveNewsNotAllowed message: Retrieving news is not allowed. type: Validation details: null rawMessage: Retrieving news is not allowed. 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 Retrieving content is not allowed: description: Example when retrieving content is not allowed. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:RetrieveContentNotAllowed message: Retrieving content is not allowed. type: Validation details: null rawMessage: Retrieving content is not allowed. 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 Start date is later than the end date.: description: Example when the start date is later than the end date. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:StartDateLaterThanEndDate message: The start effective date cannot be later than the end effective date. type: Validation details: endDate: 10/15/2024 12:00:00 AM startDate: 10/16/2024 12:00:00 AM rawMessage: The start effective date cannot be later than the end effective date. 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 Page size is out of range.: description: Example when the page size is out of range. The minimum is 10 and the maxiumum is 20. value: errors: - id: b79d85c8-b090-baa6-5efa-dbc168844eeb code: FindNewsRequest.PageSize:RangeAttribute message: The field FindNewsRequest must be between 10 and 20. type: Validation details: validation: RangeAttribute model: FindNewsRequest member: PageSize rawMessage: The field FindNewsRequest must be between 10 and 20. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Last page key exceeds maximum length.: description: Example when the last page key exceeds the maximum length of 100. value: errors: - id: b79d85c8-b090-baa6-5efa-dbc168844eeb code: FindNewsRequest.LastPageKey:StringLengthAttribute message: The field FindNewsRequest must be a string with a maximum length of 100. type: Validation details: validation: StringLengthAttribute model: FindNewsRequest member: LastPageKey rawMessage: The field FindNewsRequest must be a string with a maximum length of 100. 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 Domain code exceeds maximum length.: description: Example when the domain code exceeds the maximum length of 3. value: errors: - id: b79d85c8-b090-baa6-5efa-dbc168844eeb code: FindNewsRequest.DomainCode:StringLengthAttribute message: The field FindNewsRequest must be a string with a maximum length of 3. type: Validation details: validation: StringLengthAttribute model: FindNewsRequest member: DomainCode rawMessage: The field FindNewsRequest must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Department code exceeds maximum length.: description: Example when the department code exceeds the maximum length of 4. value: errors: - id: b79d85c8-b090-baa6-5efa-dbc168844eeb code: FindNewsRequest.DepartmentCode:StringLengthAttribute message: The field FindNewsRequest must be a string with a maximum length of 4. type: Validation details: validation: StringLengthAttribute model: FindNewsRequest member: DepartmentCode rawMessage: The field FindNewsRequest must be a string with a maximum length of 4. 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 Role code exceeds maximum length.: description: Example when the role code exceeds the maximum length of 4. value: errors: - id: b79d85c8-b090-baa6-5efa-dbc168844eeb code: FindNewsRequest.RoleCode:StringLengthAttribute message: The field FindNewsRequest must be a string with a maximum length of 4. type: Validation details: validation: StringLengthAttribute model: FindNewsRequest member: RoleCode rawMessage: The field FindNewsRequest must be a string with a maximum length of 4. 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 post: tags: - contents summary: Add a new news content item. description: "Add news or sometimes referred to as FYI Content notes.\n\nRelated\ \ endpoints:\n- `GET /resources/contents/{contentID}/data`: Allows you to\ \ view the data for a specific content item including news content.\n- `GET\ \ /contents/news`: Allows you to search for news content items.\n\nThe `OrganizationCode`\ \ is automatically set to the `OrganizationCode` of the logged in \nagent\ \ if the `DomainCode`, `DepartmentCode`, and `RoleCode` are all set in the\ \ request.\n\nOnly text based content data types are allowed. Other content\ \ data types such as `JPEG` or `PNG` must be stored elsewhere.\n\nGraphQL\ \ endpoint: newsAdd" operationId: nsk_v1_contents_news_post requestBody: x-name: addNewsRequest description: The add news request. content: application/json: schema: $ref: '#/components/schemas/AddNewsRequest' examples: Request with content data type set to text.: description: Example when the content data type is set to text. value: name: NewsWithText description: News with a text data type: 1 effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' dataType: 1 data: Sample text file for Digital API Testing. domainCode: '' departmentCode: '' roleCode: '' Request with content data type set to rich text format.: description: Example when the content data type is set to rich text format. value: name: NewsWithRichTextFormat description: News with a rich text format data type: 2 effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' dataType: 2 data: "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\\ f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n\\viewkind4\\uc1\\\ pard\\f0\\fs17 Sample rich text format file\\par\r\n}\r\n" domainCode: '' departmentCode: '' roleCode: '' Request with content data type set to HTML.: description: Example when the content data type is set to HTML. value: name: NewsWithHtml description: News with a html data type: 3 effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' dataType: 8 data:

Digital API HTML Heading

If you are reading this correctly, it means that the news content is successfully created.

domainCode: '' departmentCode: '' roleCode: '' Request with content data type set to URI.: description: Example when the content data type is set to URI. value: name: NewsWithUri description: News with an Uri data type: 4 effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' dataType: 10 data: https://www.navitaire.com domainCode: '' departmentCode: '' roleCode: '' Request with no discontinue date and retention date.: description: Example when the discontinue date and the retention date is not set. value: name: test1 description: description type: 1 effectiveDate: '2024-10-15T00:00:00' discontinueDate: null retentionDate: null dataType: 1 data: text domainCode: '' departmentCode: '' roleCode: '' News added successfully with organization code automatically set.: description: Example when news is added successfully with the organization code automatically set to the logged in agent's organization. value: name: test1 description: description type: 1 effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' dataType: 1 data: text domainCode: EXT departmentCode: TA roleCode: TAW3 required: true x-position: 1 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAddNewsResponse' examples: News with text data type is added successfully.: description: Example when a news with a text data type is added successfully. value: data: news: contentId: 240 name: NewsWithText description: News with a text data createdUserKey: MTE5MDY- createdDate: '2024-10-15T02:08:37.69+00:00' dataType: 1 size: 41 type: 1 organizationCode: null domainCode: null departmentCode: null roleCode: null effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' News with rich text format data type is added successfully.: description: Example when a news with a rich text format data type is added successfully. value: data: news: contentId: 240 name: NewsWithRichTextFormat description: News with a rich text format data createdUserKey: MTE5MDY- createdDate: '2024-10-15T02:08:37.69+00:00' dataType: 2 size: 160 type: 2 organizationCode: null domainCode: null departmentCode: null roleCode: null effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' News with HTML data type is added successfully.: description: Example when a news with a HTML data type is added successfully. value: data: news: contentId: 240 name: NewsWithHtml description: News with a html data createdUserKey: MTE5MDY- createdDate: '2024-10-15T02:08:37.69+00:00' dataType: 8 size: 171 type: 3 organizationCode: null domainCode: null departmentCode: null roleCode: null effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' News with URI data type is added successfully.: description: Example when a news with an URI data type is added successfully. value: data: news: contentId: 240 name: NewsWithUri description: News with an Uri data createdUserKey: MTE5MDY- createdDate: '2024-10-15T02:08:37.69+00:00' dataType: 10 size: 25 type: 4 organizationCode: null domainCode: null departmentCode: null roleCode: null effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' News added successfully with no discontinue date and retention date.: description: Example when news is added with no discontinue date and retention date. value: data: news: contentId: 241 name: test1 description: description createdUserKey: MTE5MDY- createdDate: '2024-10-15T02:09:06.263+00:00' dataType: 1 size: 3 type: 1 organizationCode: null domainCode: null departmentCode: null roleCode: null effectiveDate: '2024-10-15T00:00:00' discontinueDate: null retentionDate: null News added successfully with organization code automatically set.: description: Example when news is added successfully with the organization code automatically set to the logged in agent's organization. value: data: news: contentId: 242 name: test1 description: description createdUserKey: MTE5MDY- createdDate: '2024-10-15T02:27:43.83+00:00' dataType: 1 size: 3 type: 1 organizationCode: '88887777' domainCode: EXT departmentCode: TA roleCode: TAW3 effectiveDate: '2024-10-15T00:00:00' discontinueDate: '2024-10-16T00:00:00' retentionDate: '2024-10-17T00:00:00' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Name is null or empty.: description: Example when the name is null or empty. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: AddNewsRequest.Name:RequiredAttribute message: AddNewsRequest.Name:RequiredAttribute type: Validation details: member: Name model: AddNewsRequest validation: RequiredAttribute rawMessage: The AddNewsRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null News type is null.: description: Example when the news type is null. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: AddNewsRequest.Type:RequiredAttribute message: AddNewsRequest.Type:RequiredAttribute type: Validation details: member: Type model: AddNewsRequest validation: RequiredAttribute rawMessage: The AddNewsRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Content data type is null.: description: Example when the content data type is null. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: AddNewsRequest.DataType:RequiredAttribute message: AddNewsRequest.DataType:RequiredAttribute type: Validation details: member: DataType model: AddNewsRequest validation: RequiredAttribute rawMessage: The AddNewsRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Data is null or empty.: description: Example when the data is null or empty. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: AddNewsRequest.Data:RequiredAttribute message: AddNewsRequest.Data:RequiredAttribute type: Validation details: member: Data model: AddNewsRequest validation: RequiredAttribute rawMessage: The AddNewsRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Effective date is equal to the discontinuedate.: description: Example when the effective date is equal to the discontinue date. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:EffectiveDateCannotBeEqualToDiscontinueDate message: The effective date cannot be the same as the discontinue date. type: Validation details: discontinueDate: 10/15/2024 12:00:00 AM effectiveDate: 10/15/2024 12:00:00 AM rawMessage: The effective date cannot be the same as the discontinue date. 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 EffectiveDate is later than the DiscontinueDate.: description: Example when the effective date is later than the discontinue date. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: News.DiscontinueDate:MinMaxDateTimeAttribute message: The value of News.DiscontinueDate:MinMaxDateTimeAttribute is 10/15/2024 00:00:00 but must be between 10/16/2024 00:00:00 and 12/31/9999 00:00:00 inclusive. type: Validation details: null rawMessage: The value of News.DiscontinueDate:MinMaxDateTimeAttribute is 10/15/2024 00:00:00 but must be between 10/16/2024 00:00:00 and 12/31/9999 00:00:00 inclusive. 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 Discontinue date is later than the retention date.: description: Example when the discontinue date is later than the retention date. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: News.RetentionDate:MinMaxDateTimeAttribute message: The value of News.RetentionDate:MinMaxDateTimeAttribute is 10/16/2024 00:00:00 but must be between 10/17/2024 00:00:00 and 12/31/9999 00:00:00 inclusive. type: Validation details: null rawMessage: The value of News.RetentionDate:MinMaxDateTimeAttribute is 10/16/2024 00:00:00 but must be between 10/17/2024 00:00:00 and 12/31/9999 00:00:00 inclusive. 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 Discontinue date is null and the retention date is not null.: description: Example when the discontinue date is null and the retention date is not null. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:RetentionDateCannotBeSetIfDiscontinueDateIsNull message: Retention date cannot be set if discontinue date is null. type: Validation details: discontinueDate: '' retentionDate: 10/17/2024 12:00:00 AM rawMessage: Retention date cannot be set if discontinue date is 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 News type is invalid.: description: Example when the news type is invalid. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:InvalidNewsType message: Invalid news type. type: Validation details: newsType: '10' rawMessage: Invalid news type. 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 Content data type is invalid.: description: Example when the Content data type is invalid. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:InvalidContentDataType message: Invalid content data type. Allowed values are 'Text', 'RichTextFormat', 'Html', and 'Uri'. type: Validation details: contentDataType: '20' rawMessage: Invalid content data type. Allowed values are 'Text', 'RichTextFormat', 'Html', and 'Uri'. 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 Domain code is invalid.: description: Example when the domain code is invalid. See /resources/Domains for valid codes. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:InvalidDomainCode message: Invalid domain code. type: Validation details: domainCode: abc rawMessage: Invalid domain code. 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 Department code is invalid.: description: Example when the department code is invalid. See /resources/Departments for valid codes. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:InvalidDepartmentCode message: Invalid department code. type: Validation details: departmentCode: abc rawMessage: Invalid department code. 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 Role code is invalid.: description: Example when the role code is invalid. See /resources/Roles for valid codes. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:InvalidRoleCode message: Invalid role code. type: Validation details: roleCode: abc rawMessage: Invalid role code. 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 Domain code exceeds maximum length.: description: Example when the domain code exceeds the maximum length of 3. value: errors: - id: b79d85c8-b090-baa6-5efa-dbc168844eeb code: AddNewsRequest.DomainCode:StringLengthAttribute message: The field AddNewsRequest must be a string with a maximum length of 3. type: Validation details: validation: StringLengthAttribute model: AddNewsRequest member: DomainCode rawMessage: The field AddNewsRequest must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Department code exceeds maximum length.: description: Example when the department code exceeds the maximum length of 4. value: errors: - id: b79d85c8-b090-baa6-5efa-dbc168844eeb code: AddNewsRequest.DepartmentCode:StringLengthAttribute message: The field AddNewsRequest must be a string with a maximum length of 4. type: Validation details: validation: StringLengthAttribute model: AddNewsRequest member: DepartmentCode rawMessage: The field AddNewsRequest must be a string with a maximum length of 4. 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 Role code exceeds maximum length.: description: Example when the role code exceeds the maximum length of 4. value: errors: - id: b79d85c8-b090-baa6-5efa-dbc168844eeb code: AddNewsRequest.RoleCode:StringLengthAttribute message: The field AddNewsRequest must be a string with a maximum length of 4. type: Validation details: validation: StringLengthAttribute model: AddNewsRequest member: RoleCode rawMessage: The field AddNewsRequest must be a string with a maximum length of 4. 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 Adding news is not allowed.: description: Example when adding news is not allowed. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:News:AddNewsNotAllowed message: Adding news is not allowed. type: Validation details: null rawMessage: Adding news is not allowed. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/currency/converter: get: tags: - currency summary: Calculates currency conversions. description: "If the currency conversion is inverted, the exchange rate returned\ \ is of the reversed to and \nfrom currency code and the rate used in the\ \ calculation is 1/(exchange rate of the reverse).\n\nGraphQL endpoint: currencyCalculation" operationId: nsk_v1_currency_converter_get parameters: - name: FromCurrencyCode in: query description: "The currency code that the amount is currently in.\n \ \ " schema: type: string maxLength: 3 minLength: 1 nullable: true x-position: 1 - name: ToCurrencyCode in: query description: "The currency code we want the amount converted to.\n \ \ " schema: type: string maxLength: 3 minLength: 1 nullable: true x-position: 2 - name: Amount in: query description: "The amount to be converted. This will be in the FromCurrencyCode\ \ currency.\n " schema: type: number format: decimal nullable: true x-position: 3 - name: Inverted in: query description: "If set to true, the endpoint will use 1/(exchange rate of the\ \ reverse) during the conversion. Defaults to false if no value is set.\n\ \ " schema: type: boolean nullable: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCurrencyConversion' examples: Direct currency conversion successful: description: Example when using direct currency conversion. value: data: convertedAmount: 2319.4 fromCurrencyCode: EUR exchangeRate: 1.16 toCurrencyCode: USD roundingFactor: 0.1 amount: 1999.52 marketingRoundingFactor: 0.1 inverted: false Inverse currency conversion successful: description: Example when using inverse currency conversion. value: data: convertedAmount: 199.5 fromCurrencyCode: EUR exchangeRate: 1.16 toCurrencyCode: USD roundingFactor: 0.1 amount: 231.4 marketingRoundingFactor: 0.1 inverted: true '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Currency Code Error: description: Example error when currency code is invalid. value: errors: - id: fc79d927-e7c3-91ce-8ae8-fbd0adf7bb39 code: nsk:Currency:InvalidCurrencyCode message: nsk:Currency:InvalidCurrencyCode type: Validation details: null rawMessage: The currency code ABC is either invalid or inactive in the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Currency Conversion Failed: description: Example error when currency conversion failed. value: errors: - id: 1a68ef3e-44b5-08d4-9395-e69695467a5d code: nsk:Currency:CurrencyConversionFailed message: nsk:Currency:CurrencyConversionFailed type: Validation details: null rawMessage: The currency conversion failed unexpectedly. Please verify the currency codes are valid and active in the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Amount Required Error: description: Example error when amount is not set. value: errors: - id: e53dd703-1362-d1b2-64c4-c9b1a5f853fb code: CurrencyConversionRequest.Amount:RequiredAttribute message: CurrencyConversionRequest.Amount:RequiredAttribute type: Validation details: validation: RequiredAttribute model: CurrencyConversionRequest member: Amount rawMessage: The CurrencyConversionRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null ToCurrencyCode Required Error: description: Example error when ToCurrencyCode is not set. value: errors: - id: c20fe6e2-2d91-7855-1d0b-613f97da120e code: CurrencyConversionRequest.ToCurrencyCode:RequiredAttribute message: CurrencyConversionRequest.ToCurrencyCode:RequiredAttribute type: Validation details: validation: RequiredAttribute model: CurrencyConversionRequest member: ToCurrencyCode rawMessage: The CurrencyConversionRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null FromCurrencyCode Required Error: description: Example error when FromCurrencyCode is not set. value: errors: - id: 1b6d7366-8ae6-b361-8333-f60f9c7306ac code: CurrencyConversionRequest.FromCurrencyCode:RequiredAttribute message: CurrencyConversionRequest.FromCurrencyCode:RequiredAttribute type: Validation details: validation: RequiredAttribute model: CurrencyConversionRequest member: FromCurrencyCode rawMessage: The CurrencyConversionRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/dcs/v1/equipment/swap: post: tags: - equipment summary: Exchanges one equipment for another on an existing flight. description: 'Specifically, the leg is updated with a new transport code and equipment information. All seat assignments on the affected flight legs are examined. Any assignments for seats which do not exist in the new equipment are released. Those passengers will no longer have seat assignments on the affected legs As a result of the equipment swap, passengers may end up with a different cabin or class of service than they had on the prior equipment. This method is only concerned with making sure that the seat assignment physically exists on the new configuration. Any seat holds or blocks on seats which no longer exist are also released. This method does not revise the inventory or SSR lids on the swapped flight legs. These values may become invalid after an equipment swap. This method also may return a list of passengers what were moved from one equipment to another that had a seat change. GraphQL endpoints: equipmentSwap, equipmentSwapBatch' operationId: dcs_v1_equipment_swap_post requestBody: x-name: request description: The equipment swap request. content: application/json: schema: $ref: '#/components/schemas/EquipmentSwapRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEquipmentSwapPassenger' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/equipment/tailNumber: post: tags: - equipment summary: Assigns a tail number to a specific leg. description: 'To confirm the assignment of the tail number, please use /api/nsk/v2/trip/info/{legKey}/status. If the aircraft code of the leg is different from the aircraft code of the tail number, an equipment swap will be required to assign the tail number and the tail number will not be changed until that swap. This equipment swap requirement can be overriden using `IgnoreEquipmentDifference` on the request, however this should be used with caution. GraphQL endpoints: tailNumber, tailNumberBatch' operationId: dcs_v1_equipment_tailNumber_post requestBody: x-name: request description: The request for assigning the tail number. content: application/json: schema: $ref: '#/components/schemas/AssignTailNumberRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAssignTailNumbersResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAssignTailNumbersResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/eTickets/{eTicketNumber}: get: tags: - eTickets summary: 'Retrieves the passenger''s e-ticket and its details by providing the ticket number, hosted carrier code and the alternate carrier code from the e-ticket database if the ticket is OA validated (issued by the other airline not by the hosted carrier).' description: 'GraphQL endpoint: eTicketv3' operationId: nsk_v2_eTickets_eTicketNumber_get parameters: - name: eTicketNumber in: path required: true description: The e-ticket number. schema: type: string x-position: 1 - name: HostedCarrierCode in: query description: "The hosted carrier code. If not provided, the hosted carrier\ \ code will be retrieved internally.\n " schema: type: string nullable: true x-position: 2 - name: AlternateCarrierCode in: query description: "The alternate carrier code. This is required if the ticket is\ \ issued by another airline.\n " schema: type: string nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfETicketResponsev2' examples: Initially issued e-tickets: description: Example response for successful retrieval of issued e-tickets value: eTicket: passengerName: first: Example middle: null last: Passenger title: null suffix: null connectedETickets: - couponCount: 1 ticketNumber: 0286010103190 ticketEmds: null exchangedETickets: [] recordLocators: - recordLocatorKey: Vzk0SFVHIQa-- recordCode: ABCDEF systemDomainCode: null owningSystemCode: null bookingSystemCode: NV interactionPurpose: null hostedCarrierCode: null fareCalculation: SLC NV BOS84.65USD84.65END issueDate: '2026-07-09T00:00:00Z' companyIdNumber: '0000' chargeCode: null totalTaxAmount: 25.0 taxDetailsList: - taxCode: CGY amount: 20.0 currencyCode: USD ticketFare: baseAmount: 150.0 currencyCode: USD foreignAmount: 0.0 foreignCurrencyCode: null totalAmount: 200.0 totalAmountCurrencyCode: USD remarks: - textQualifier: 3 informationType: 10 freeTexts: - THIS COMMENT IS FOR VOLUNTARY ISSUANCE OF E TICKET - textQualifier: 3 informationType: 12 freeTexts: - SLC NV BOS84.65USD84.65END - textQualifier: 3 informationType: 13 freeTexts: - SALT LAKE CITY US - NAV1 DEFAULT CARRIER - textQualifier: 3 informationType: 14 freeTexts: - SLC10NOV231234567 createdUserIdentifier: '45321' status: 1 alternateCarrierCode: NV Re-issued e-tickets: description: Example response for successful retrieval of re-issued e-tickets value: eTicket: passengerName: first: Example middle: null last: Passenger title: null suffix: null connectedETickets: - couponCount: 1 ticketNumber: 0286010103191 ticketEmds: null exchangedETickets: - couponCount: 1 ticketNumber: 0286010103190 ticketEmds: null recordLocators: - recordLocatorKey: Vzk0SFVHIQa-- recordCode: ABCDEF systemDomainCode: null owningSystemCode: null bookingSystemCode: NV interactionPurpose: null hostedCarrierCode: null fareCalculation: SLC NV BOS84.65USD84.65END issueDate: '2026-07-09T00:00:00Z' companyIdNumber: '0000' chargeCode: null totalTaxAmount: 25.0 taxDetailsList: - taxCode: CGY amount: 20.0 currencyCode: USD ticketFare: baseAmount: 150.0 currencyCode: USD foreignAmount: 0.0 foreignCurrencyCode: null totalAmount: 200.0 totalAmountCurrencyCode: USD remarks: - textQualifier: 3 informationType: 10 freeTexts: - THIS COMMENT IS FOR INVOLUNTARY ISSUANCE OF E TICKET - textQualifier: 3 informationType: 12 freeTexts: - SLC NV BOS84.65USD84.65END - textQualifier: 3 informationType: 13 freeTexts: - SALT LAKE CITY US - NAV1 DEFAULT CARRIER - textQualifier: 3 informationType: 14 freeTexts: - ' 0286010103190 SLC10NOV231234567' createdUserIdentifier: '45321' status: 1 alternateCarrierCode: NV '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Non-existent e-Ticket: description: Example error when retrieving non-existent or invalid e-tickets value: errors: - id: null code: nsk:ETicket:ETicketNotFoundInETicketDatabase message: nsk:ETicket:ETicketNotFoundInETicketDatabase type: Error details: null rawMessage: The e-ticket number 0286010103199 was not found in the e-ticket database. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/eTickets/{eTicketNumber}/coupons: get: tags: - eTickets summary: Retrieves all coupons associated with the e-ticket. description: 'GraphQL endpoint: eTicketCouponsv2' operationId: nsk_v1_eTickets_eTicketNumber_coupons_get parameters: - name: eTicketNumber in: path required: true description: The e-ticket number. schema: type: string x-position: 1 - name: HostedCarrierCode in: query description: "The hosted carrier code. If not provided, the hosted carrier\ \ code will be retrieved internally.\n " schema: type: string nullable: true x-position: 2 - name: AlternateCarrierCode in: query description: "The alternate carrier code. This is required if the ticket is\ \ issued by another airline.\n " schema: type: string nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfETicketCoupon' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/eTickets/{eTicketNumber}/coupons/{couponNumber}: get: tags: - eTickets summary: Retrieves a single coupon associated with the e-ticket. description: 'GraphQL endpoint: eTicketCouponv2' operationId: nsk_v1_eTickets_eTicketNumber_coupons_couponNumber_get parameters: - name: eTicketNumber in: path required: true description: The e-ticket number. schema: type: string x-position: 1 - name: couponNumber in: path required: true description: The e-ticket coupon number. schema: type: integer x-position: 2 - name: HostedCarrierCode in: query description: "The hosted carrier code. If not provided, the hosted carrier\ \ code will be retrieved internally.\n " schema: type: string nullable: true x-position: 3 - name: AlternateCarrierCode in: query description: "The alternate carrier code. This is required if the ticket is\ \ issued by another airline.\n " schema: type: string nullable: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfETicketCoupon' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/eTickets/{eTicketNumber}/coupons/{couponNumber}: put: tags: - eTickets summary: Updates a coupon contained in an e-ticket. description: 'GraphQL endpoint: eTicketCouponSetv3' operationId: nsk_v2_eTickets_eTicketNumber_coupons_couponNumber_put parameters: - name: eTicketNumber in: path required: true description: The e-ticket number to update. schema: type: string x-position: 1 - name: couponNumber in: path required: true description: The coupon number to update schema: type: integer x-position: 2 requestBody: x-name: request description: The e-ticket coupon update request. content: application/json: schema: $ref: '#/components/schemas/UpdateETicketCouponRequestBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfUpdateETicketCouponResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/fareRules/{fareAvailabilityKey}: get: tags: - fareRules summary: Gets the fare rules from the server based on a fare availability key. description: 'Note that this defaults to returning the fare rules in HTML format. The HTML format may not be entirely culture sensitive, so setting the convertToHtml flag to false will allow users some flexibility when converting the content and the fare rules will be returned as an RTF string. GraphQL endpoint: fareRulesByAvailabilityKeyv2' operationId: nsk_v1_fareRules_fareAvailabilityKey_get parameters: - name: fareAvailabilityKey in: path required: true description: The unique fare availability key to get rules for. schema: type: string x-position: 1 - name: convertToHtml in: query description: Whether to convert to HTML. Defaults to true. schema: type: boolean nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareRule' examples: Retrieve Fare Rules Stateless: description: Example response for successfully retrieving the fare rules statelessly. value: data: fareSellKey: MH5Rfn5NS35RVENGQVJFfkNDNTB_fjF_MX5OTU5MWVRaMDAxMDAxMH5YXjB_U35_TUt_UVRDRkFSRX5DQzUwfn4xfjF_Tk1OTFlUWjAwMTAwMTB_WCEwMg-- content: 'Fare Rules and Conditions: Tickets are available for purchase by all individuals aged 18 and above.' With Empty Fare Rules List: description: Example response when there are no fare rules returned. value: data: [] '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Fare Availability Key: description: The fare availability key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'fareAvailabilityKey' with value 'MTW' is invalid. type: Validation details: fareAvailabilityKey: MTW rawMessage: The identifier 'fareAvailabilityKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/fareRules/category50/journeys/{journeyKey}/segments/{segmentKey}: post: tags: - fareRules summary: Get the category 50 fare rule information after an availability call. description: 'This is functionally a GET but POST is used to reduce URL length overhead. GraphQL endpoint: category50FareRuleInfov2' operationId: nsk_v2_fareRules_category50_journeys_journeyKey_segments_segmentKey_post parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The segment key. schema: type: string x-position: 2 requestBody: x-name: request description: The v2 category 50 request. content: application/json: schema: $ref: '#/components/schemas/Category50Requestv2' examples: Category 50 Fare Rule Request: description: Example request for retrieving category 50 fare rule information. value: fareAvailabilityKey: MH5Rfn5NS35RVENGQVJFfkNDNTB_fjF_MX5OTU5MWVRaMDAxMDAxMH5Y passengerPriceTypes: - passengerType: ADT passengerDiscountCode: ADT passengerCount: 1 cultureCode: en-US convertToHtml: true required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCategory50Responsev2' examples: Retrieve Category 50 Fare Rule Information: description: Example response for successfully retrieving the category 50 fare rule information. value: data: title: Category 50 Fare Rule text: 'Fare Rules and Conditions: Tickets are available for purchase by all individuals aged 18 and above.' dataType: 0 cultureCode: en-US '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Journey Key: description: The journey key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'journeyKey' with value 'MTW' is invalid. type: Validation details: journeyKey: MTW rawMessage: The identifier 'journeyKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Segment Key: description: The segment key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'segmentKey' with value 'MTW' is invalid. type: Validation details: segmentKey: MTW rawMessage: The identifier 'segmentKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Fare Availability Key: description: The fare availability key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'fareAvailabilityKey' with value 'MTW' is invalid. type: Validation details: fareAvailabilityKey: MTW rawMessage: The identifier 'fareAvailabilityKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Null Fare Rule Information: description: Example response when there is no fare rule information returned. value: data: null /api/v1/graph: post: tags: - graph summary: Invokes a graph query and returns the response. operationId: v1_graph_post requestBody: x-name: query content: application/json: schema: $ref: '#/components/schemas/GraphQlQuery' required: true x-position: 1 responses: '200': description: The graph json response. content: application/octet-stream: schema: type: string format: binary deprecated: true /api/v2/graph/{queryName}: post: tags: - graph summary: Invokes a graph query and returns the response. description: Invokes a graph query and returns the response. operationId: v2_graph_queryName_post parameters: - name: queryName in: path required: true description: The unique name used for reporting. schema: type: string x-position: 2 - name: cachedResults in: query description: "Cached results query string parameter. This is the same as the\ \ post variable but enables\nvarious tools to set the same value.\n \ \ " schema: type: boolean x-position: 3 requestBody: x-name: query description: Query details. 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: OK. Request completed successfully. 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/nsk/v1/graph/{queryName}: post: tags: - graph summary: Invokes a graph query configured in utilities. description: 'When a graph query is configured on the server under Resource Management it allows your payload sizes to be even smaller.' operationId: nsk_v1_graph_queryName_post parameters: - name: queryName in: path required: true description: The query name matching your resource management configuration. schema: type: string x-position: 1 - name: cachedResults in: query description: True to return cached results. schema: type: boolean x-position: 2 requestBody: x-name: variables description: The json matching your json variables in your graph query. content: application/json: schema: {} x-position: 3 responses: '200': description: The graph json response. content: application/octet-stream: schema: type: string format: binary /api/v1/health: get: tags: - health summary: Gets the current environment's health status. operationId: v1_health_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfEnvironmentHealth' deprecated: true /api/v2/health: get: tags: - health summary: Returns a simple health check that will return a 200 if the server is responding. description: 'This health check will not ensure that the required underlying services are working. For a more detailed health check that will validate configuration and third party services please use a different health endpoint.' operationId: v2_health_get responses: '200': description: OK. Request completed successfully. deprecated: true /api/v3/health: get: tags: - health summary: Performs the health check. description: 'This endpoint does not require a token. If the health check returns an overall status of "Ok", the expected HTTP status code response would be a "200 - Ok". If the health check returns an overall status of "Warning", the expected HTTP status code response would be a "299". This is a custom code not typically mapped as per industry standards, and was done intentionally to indicate a warning response from the health endpoint. If the health check returns an overall status of "Error", the expected HTTP status code response would be a "500 - InternalServerError".' operationId: v3_health_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/EnvironmentHealth' '299': description: Request completed successfully with warnings from health endpoint. content: application/json: schema: $ref: '#/components/schemas/EnvironmentHealth' '500': description: Request to health endpoint did not complete successfully. content: application/json: schema: $ref: '#/components/schemas/EnvironmentHealth' /api/dcs/v2/inventory/legs/{legKey}: get: tags: - inventory summary: Gets the stateless inventory leg. description: 'GraphQL endpoint: inventoryLegv2' operationId: dcs_v2_inventory_legs_legKey_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfInventoryLegv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - inventory summary: Patches an inventory leg's data, its nests' data, and its classes' data based on information in the request. description: 'GraphQL endpoint: inventoryLegModifyv2' operationId: dcs_v2_inventory_legs_legKey_patch parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 requestBody: x-name: request description: The inventory leg edit request. content: application/json: schema: $ref: '#/components/schemas/InventoryLegEditv2Request' examples: Patching leg, nest, and class: description: Example request for patching inventory leg, nest, and class data value: lid: 50 adjustedCapacity: 48 sendAvsMessages: true status: 0 nests: mtEzNTk2MTAxNSE0IU4-: lid: 24 adjustedCapacity: 23 classes: null mtEzNTk2MTAxNSExIU4-: lid: null adjustedCapacity: null classes: mtEzNTk2MTAxNSExIU0-: type: 0 rank: 1 authorizedUnits: 10 allotted: 9 latestAdvancedReservation: 0 mtEzNTk2MTAxNSEyIU4-: lid: 50 adjustedCapacity: 48 classes: mtEzNTk2MTAxNSEyIU4-: type: null rank: null authorizedUnits: 10 allotted: null latestAdvancedReservation: null mtEzNTk2MTAxNSEyIU8-: type: null rank: null authorizedUnits: null allotted: 36 latestAdvancedReservation: 5 Patching just leg lid: description: Example request for patching just inventory leg lid value: lid: 50 adjustedCapacity: null sendAvsMessages: false status: null nests: null Patching leg class: description: Example request for patching just an inventory class value: lid: null adjustedCapacity: null sendAvsMessages: false status: null nests: mtEzNTk2MTAxNSExIU4-: lid: null adjustedCapacity: null classes: mtEzNTk2MTAxNSExIU0-: type: null rank: null authorizedUnits: null allotted: 9 latestAdvancedReservation: null required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/inventory/legs/{legKey}/nests/{legNestKey}: get: tags: - inventory summary: Gets an inventory leg nest by key. description: 'GraphQL endpoint: inventoryNest' operationId: dcs_v1_inventory_legs_legKey_nests_legNestKey_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: legNestKey in: path required: true description: The leg nest key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfInventoryLegNest' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - inventory summary: Patches an inventory leg nest's data based on information in the request. description: 'GraphQL endpoint: inventoryNestModify' operationId: dcs_v1_inventory_legs_legKey_nests_legNestKey_patch parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: legNestKey in: path required: true description: The leg nest key. schema: type: string x-position: 2 requestBody: x-name: request description: The inventory nest edit request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfInventoryNestEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/inventory/legs/{legKey}/nests/{legNestKey}/classes/{legClassKey}: get: tags: - inventory summary: Gets an inventory leg nest class by key. description: 'GraphQL endpoint: inventoryClass' operationId: dcs_v1_inventory_legs_legKey_nests_legNestKey_classes_legClassKey_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: legNestKey in: path required: true description: The leg nest key. schema: type: string x-position: 2 - name: legClassKey in: path required: true description: The leg class key. schema: type: string x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfInventoryLegClass' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - inventory summary: Patches an inventory leg nest class's data based on information in the request. description: 'GraphQL endpoint: inventoryClassModify' operationId: dcs_v1_inventory_legs_legKey_nests_legNestKey_classes_legClassKey_patch parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: legNestKey in: path required: true description: The leg nest key. schema: type: string x-position: 2 - name: legClassKey in: path required: true description: The leg class key. schema: type: string x-position: 3 requestBody: x-name: request description: The inventory class edit request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfInventoryClassEditRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/inventory/legs/ssrs/lids: post: tags: - inventory summary: 'Returns a list of leg keys and their ssr nest codes and lids. Structured as a POST but behaves as a GET.' description: 'This is a batch endpoint. To get ssr lid information for a single leg, please use GET `api/dcs/v2/inventory/legs/{legKey}`.' operationId: dcs_v1_inventory_legs_ssrs_lids_post requestBody: x-name: legKeyList description: The list of leg keys. content: application/json: schema: type: array items: type: string examples: Retrieving ssr lid counts: description: Example for requesting ssr lid counts for multiple legs. value: - NjM4ODQ2MjgwMDAwMDAwMDAwIU5WITk5ISAhU0xDIUJPUyEyNDk2MTY5 - NjM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxNzQ- - NjM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxQk9- required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDictionaryOfStringAndListOfInventoryLegSSRLid' examples: Successful batch ssr lid retrieval.: description: Example response of a successful batch ssr lid retrieval for multiple legs. value: data: njM4ODQ2MjgwMDAwMDAwMDAwIU5WITk5ISAhU0xDIUJPUyEyNDk2MTY5: - ssrNestCode: BLND lid: 20 - ssrNestCode: CHLD lid: 100 - ssrNestCode: MEAL lid: 810 njM4ODQ2NDYwMDAwMDAwMDAwIU5WITU2NjEhICFTTEMhQk9TITI0OTYxNDc-: - ssrNestCode: WIFI lid: 800 - ssrNestCode: PETC lid: 10 njM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxNzQ-: - ssrNestCode: BG15 lid: 80 - ssrNestCode: BG20 lid: 10 - ssrNestCode: LEGX lid: 6 - ssrNestCode: PETC lid: 15 '207': description: "\n Multi Status. Some leg keys were invalid\ \ or could not be retrieved. See the response messages for\n \ \ details.\n " content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDictionaryOfStringAndListOfInventoryLegSSRLid' examples: Partially-successful batch ssr lid retrieval.: description: Example response of a partially-successful batch ssr lid retrieval for multiple legs. value: messages: - rawValue: The leg key 'ABCDE' is invalid. code: dcs:Inventory:InvalidLegKey debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: dcs:Inventory:InvalidLegKey status: 1 details: legKey: ABCDE data: njM4ODQ2MjgwMDAwMDAwMDAwIU5WITk5ISAhU0xDIUJPUyEyNDk2MTY5: - ssrNestCode: BLND lid: 20 - ssrNestCode: CHLD lid: 100 - ssrNestCode: MEAL lid: 810 njM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxNzQ-: - ssrNestCode: BG15 lid: 80 - ssrNestCode: BG20 lid: 10 - ssrNestCode: LEGX lid: 6 - ssrNestCode: PETC lid: 15 '400': description: None of the provided leg keys are valid. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: All leg keys invalid: description: Example error when none of the provided leg keys are valid. value: errors: - id: null code: dcs:Inventory:InvalidLegKey message: The leg key(s) are invalid. type: Validation details: null rawMessage: The leg key(s) are invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: None of the requested legs were found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: None of leg keys were found: description: Example error when none of the provided leg keys were found. value: data: null patch: tags: - inventory summary: Patches the ssr lids for multiple specified legs. description: 'This is a batch endpoint. It accepts a list of leg keys in the body along with their SSR nest codes and requested lids. If a leg has an SSR that is not specified in the parameter list, that SSR will not be updated. Related Endpoints: GET `api/dcs/v2/inventory/legs/{legKey}`: Retrieves the current configuration for a leg and retrieve the SSR nest codes used for this endpoint. GET `api/nsk/v1/bookings/{recordLocator}`: Retrieves the current configuration related to a booking.Requires a login with person type: Agent.' operationId: dcs_v1_inventory_legs_ssrs_lids_patch requestBody: x-name: request description: The list of leg keys and their respective ssr lid lists to patch. content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryLegSSRLidsPatchRequest' examples: Patching ssr lid counts: description: Example for patching ssr lid counts for multiple legs. SSRs not included in the request list will be unaffected. value: - legKey: NjM4ODQ2MjgwMDAwMDAwMDAwIU5WITk5ISAhU0xDIUJPUyEyNDk2MTY5 ssrLids: - ssrNestCode: BLND lid: 20 - ssrNestCode: CHLD lid: 100 - ssrNestCode: MEAL lid: 810 - legKey: NjM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxNzQ- ssrLids: - ssrNestCode: WIFI lid: 800 - ssrNestCode: PETC lid: 10 - legKey: NjM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxQk9- ssrLids: - ssrNestCode: BG15 lid: 80 required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '207': description: Multi Status. Some SSR lids were updated and some failed. See the response messages for details. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Partially-successful ssr lid patch.: description: Example response of a partially-successful ssr lid patch, where some lids were updated and some were not. value: messages: - rawValue: SSR lid update failed for leg key 'NjM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxNzQ-' and ssr nest code 'INVALIDCODE1'. code: dcs:Inventory:FailedSSRLidUpdate debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: dcs:Inventory:FailedSSRLidUpdate status: 1 details: ssrNestCode: INVALIDCODE1 - rawValue: SSR lid update failed for leg key 'NjM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxNzQ-' and ssr nest code 'INVALIDCODE2'. code: dcs:Inventory:FailedSSRLidUpdate debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: dcs:Inventory:FailedSSRLidUpdate status: 1 details: ssrNestCode: INVALIDCODE2 data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Leg key(s) are invalid: description: Example error when the provided leg key(s) are all invalid. value: errors: - id: null code: dcs:Inventory:InvalidLegKey message: The leg key(s) are invalid. type: Validation details: null rawMessage: The leg key(s) are invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. messages: - rawValue: The leg key 'ABC' is invalid. code: dcs:Inventory:InvalidLegKey debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: The leg key 'ABC' is invalid. status: 1 details: legKey: ABC - rawValue: The leg key 'DEF' is invalid. code: dcs:Inventory:InvalidLegKey debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: The leg key 'DEF' is invalid. status: 1 details: legKey: DEF data: null Leg key(s) are not found: description: Example error when the provided leg key(s) are valid but not found. value: errors: - id: null code: dcs:Inventory:LegKeyNotFound message: The leg key(s) were not found. type: Validation details: null rawMessage: The leg key(s) were not found. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. messages: - rawValue: The leg key 'LTg1ODQ1MTgxMzI3OTkwMzAxOTQhbnd4ITc3NiHvv78hb1NXIUhBayEy' was not found. code: dcs:Inventory:LegKeyNotFound debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: The leg key 'LTg1ODQ1MTgxMzI3OTkwMzAxOTQhbnd4ITc3NiHvv78hb1NXIUhBayEy' was not found. status: 1 details: legKey: LTg1ODQ1MTgxMzI3OTkwMzAxOTQhbnd4ITc3NiHvv78hb1NXIUhBayEy - rawValue: The leg key 'LTg1ODQ1MTgxMzQzNzg1NDE1NzchTHJvITQ0NyHvv78hZ3pVIVFGWSEy' was not found. code: dcs:Inventory:LegKeyNotFound debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: The leg key 'LTg1ODQ1MTgxMzQzNzg1NDE1NzchTHJvITQ0NyHvv78hZ3pVIVFGWSEy' was not found. status: 1 details: legKey: LTg1ODQ1MTgxMzQzNzg1NDE1NzchTHJvITQ0NyHvv78hZ3pVIVFGWSEy data: null SSR lids not updated: description: Example error when none of the provided ssr nest lids were updated. value: errors: - id: null code: dcs:Inventory:FailedSSRLidUpdate message: SSR lid updates failed. type: Validation details: null rawMessage: SSR lid updates failed. 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. messages: - rawValue: SSR lid update failed for leg key 'NjM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxNzQ-' and ssr nest code 'INVALIDCODE1'. code: dcs:Inventory:FailedSSRLidUpdate debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: dcs:Inventory:FailedSSRLidUpdate status: 1 details: ssrNestCode: INVALIDCODE1 - rawValue: SSR lid update failed for leg key 'NjM4ODQ2MjQ0MDAwMDAwMDAwIU5WITU2ODIhICFTTEMhQk9TITI0OTYxNzQ-' and ssr nest code 'INVALIDCODE2'. code: dcs:Inventory:FailedSSRLidUpdate debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Warning value: dcs:Inventory:FailedSSRLidUpdate status: 1 details: ssrNestCode: INVALIDCODE2 data: null '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/inventory/routes/{tripKey}/classes: get: tags: - inventory summary: Gets the classes for a route, stateless. description: 'GraphQL endpoint: inventoryRouteClasses' operationId: dcs_v1_inventory_routes_tripKey_classes_get parameters: - name: tripKey in: path required: true description: The trip key from a manifest or flight info. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfInventoryRouteClass' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/inventory/routes/{tripKey}/classes/{classOfService}: patch: tags: - inventory summary: Patches an inventory route class's data based on information in the request. description: 'GraphQL endpoint: inventoryRouteClassModify' operationId: dcs_v1_inventory_routes_tripKey_classes_classOfService_patch parameters: - name: tripKey in: path required: true description: The trip key. schema: type: string x-position: 1 - name: classOfService in: path required: true description: The class of service. schema: type: string x-position: 2 requestBody: x-name: request description: The inventory class edit request. content: application/json: schema: $ref: '#/components/schemas/InventoryRouteClassEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/inventory/routes/{tripKey}/classes/{classOfService}/authorizedUnit: delete: tags: - inventory summary: Deletes an inventory route class's authorized unit. description: 'GraphQL endpoint: inventoryRouteClassAuthorizedUnitDelete' operationId: dcs_v1_inventory_routes_tripKey_classes_classOfService_authorizedUnit_delete parameters: - name: tripKey in: path required: true description: The trip key. schema: type: string x-position: 1 - name: classOfService in: path required: true description: The class of service. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/manifest: get: tags: - manifest summary: 'Gets the manifest trip information response list for the specified manifest trip information search request.' description: 'GraphQL endpoint: manifestSearchv2' operationId: nsk_v2_manifest_get parameters: - name: Origin in: query description: "The departure station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 1 - name: Destination in: query description: "The arrival station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: CarrierCode in: query description: "The carrier code.\n " schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 3 - name: BeginDate in: query description: "The starting date of the trip information search.\n \ \ " schema: type: string format: date-time nullable: true x-position: 4 - name: Identifier in: query description: "The transportation identifier, such as a flight number.\n \ \ " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 5 - name: FlightType in: query description: "The flight type.\n \nEnumeration values: 0 = All,\ \ 1 = NonStop, 2 = Through, 3 = Direct, 4 = Connect" schema: nullable: true $ref: '#/components/schemas/OperationsFlightType' x-position: 6 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationResponsev2' /api/nsk/v1/manifest/{legKey}: get: tags: - manifest summary: Gets the manifest for the specified leg. description: 'GraphQL endpoint: manifestv3' operationId: nsk_v1_manifest_legKey_get parameters: - name: legKey in: path required: true description: The manifest leg key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfManifestLight' examples: Manifest Light Response: description: Example response for retrieving the manifest. value: data: passengers: - balanceDue: true userKey: Nzk3MTZ- personKey: MA-- passengerAlternateKey: NML4Tgw passengerKey: MCFBRFQ- checkInType: 0 customerNumber: '888888888' discountCode: null infant: null name: first: First middle: Middle last: Last title: MR suffix: null paidStatus: 0 profileStatus: 0 program: null recordLocator: R35N2F sourcePointOfSale: agentCode: agent domainCode: EXT locationCode: WWW organizationCode: '88887777' bookingStatus: 0 passengerInformation: nationality: US residentCountry: US gender: 1 dateOfBirth: '0001-01-01T00:00:00' familyNumber: null declaredGender: null type: ADT bookingDate: '2026-07-09T05:55:14.8216718+00:00' soldDate: '2026-07-09T05:55:14.8216724+00:00' journey: customerRecognition: code: null points: 0 segmentCount: 1 segment: bookingStatus: HK changeReason: 0 classOfService: N fareBasisCode: NNNN leg: boardingSequence: 0 boardingZone: 3 compartmentDesignator: E legNumber: 1 liftStatus: 0 priorityCode: null priorityDate: '2026-07-09T05:55:14.8216741+00:00' unitAssignmentWeight: 0 unitDesignator: 1D manifestLegKey: NjM4ODIzNDU2MDAwMDAwMDAwIU5WITU2MjUhICFERU4hU0xD productClassCode: EC seatProperties: [] soldDate: '2026-07-09T05:55:14.821675+00:00' ticketIndicator: null ticketNumber: null upgradeIndicator: false externalIdentifier: null legCount: 1 segmentType: 0 manifestSegmentKey: NjM4ODIzNDU2MDAwMDAwMDAwIU5WITU2MjUhICFERU4hU0xD ticketFareBasis: null changeReason: 0 cabinPassengerCounts: - classRank: 0 checkedIn: 0 cabinOfService: F clearedStandBy: 0 clearedThruStandby: 0 manifested: 0 noShow: 0 standBy: 0 thruCheckedIn: 0 thruManifested: 0 thruNoShow: 0 thruStandBy: 0 totalCheckedIn: 0 totalOnBoard: 0 inventoryLegCrossReferences: - legKey: NjM4NjQ4NLQ1NSMxNCBlNSNwIUpCITExMTEhICFTTEMhQk9TITMwMTM3NTM- number: 1 marketInformation: identifier: identifier: '5600' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T05:55:14.8217633+00:00' passengerCounts: checkedIn: 0 clearedStandBy: 0 clearedThruStandby: 0 manifested: 1 noShow: 1 standBy: 0 thruCheckedIn: 0 thruManifested: 0 thruNoShow: 0 thruStandBy: 0 totalCheckedIn: 0 totalOnBoard: 0 checkInLid: 810 codeShareIndicator: null operatedByText: null operatingIdentifier: null legStatus: 0 /api/nsk/v1/manifest/{legKey}/bags: get: tags: - manifest summary: 'Gets the manifest Passenger Bags for the specified leg. Sorted by recordLocator and then by Passenger. weightType 0 = Default, 1 = Pounds, 2 = Kilograms, (2 is current default for backwards compatibility)' description: 'GraphQL endpoint: manifestBags' operationId: nsk_v1_manifest_legKey_bags_get parameters: - name: legKey in: path required: true description: The manifest leg key. schema: type: string x-position: 1 - name: weightType in: query description: "Weight type. 0 = Default, 1 = Pounds, 2 = Kilograms. \nEnumeration\ \ values: 0 = Default, 1 = Pounds, 2 = Kilograms" schema: nullable: true $ref: '#/components/schemas/WeightType2' x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIDictionaryOfStringAndIListOfOperationBag' examples: Manifest Bag Valid Response: description: This is a valid Manifest Bag Expected Response. value: xxxxxx - recordLocator: passenger1AlternateKey: - operationBagKey: BagKey identifier: NV1111 baggageStatus: 1 nonStandard: true checkInDate: '2026-07-09T00:00:00+00:00' osTag: bagOsTag compartment: 1 taggedToStation: SLC taggedToStationCity: SLC weight: 10 baggageTypeCode: null weightType: 0 - operationBagKey: BagKey2 identifier: NV1111 baggageStatus: 3 nonStandard: true checkInDate: '2026-07-09T00:00:00+00:00' osTag: bagOsTag2 compartment: 1 taggedToStation: SLC taggedToStationCity: SLC weight: 10 baggageTypeCode: null weightType: 1 passenger2AlternateKey: - operationBagKey: BagKey3 identifier: NV1111 baggageStatus: 1 nonStandard: true checkInDate: '2026-07-09T00:00:00+00:00' osTag: bagOsTag3 compartment: 1 taggedToStation: SLC taggedToStationCity: SLC weight: 10 baggageTypeCode: null weightType: 0 xxxxX2 - recordLocator 2: passenger3AlternateKey: - operationBagKey: BagKey4 identifier: NV1111 baggageStatus: 1 nonStandard: true checkInDate: '2026-07-09T00:00:00+00:00' osTag: bagOsTag4 compartment: 1 taggedToStation: SLC taggedToStationCity: SLC weight: 10 baggageTypeCode: null weightType: 0 passenger4AlternateKey: - operationBagKey: BagKey5 identifier: NV1111 baggageStatus: 1 nonStandard: true checkInDate: '2026-07-09T00:00:00+00:00' osTag: bagOsTag5 compartment: 1 taggedToStation: SLC taggedToStationCity: SLC weight: 10 baggageTypeCode: null weightType: 0 - operationBagKey: BagKey6 identifier: NV1111 baggageStatus: 3 nonStandard: true checkInDate: '2026-07-09T00:00:00+00:00' osTag: bagOsTag6 compartment: 1 taggedToStation: SLC taggedToStationCity: SLC weight: 10 baggageTypeCode: null weightType: 1 /api/nsk/v1/manifest/{legKey}/bookings: get: tags: - manifest summary: Gets the manifest bookings data for the specified leg. description: 'GraphQL endpoint: manifestBookings' operationId: nsk_v1_manifest_legKey_bookings_get parameters: - name: legKey in: path required: true description: The manifest leg key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndManifestBookings' /api/nsk/v1/manifest/{legKey}/governmentSecurityInfo: get: tags: - manifest summary: Gets the manifest Passenger Government Security Information for the specified leg. description: 'GraphQL endpoint: manifestGovernmentSecurityInformation' operationId: nsk_v1_manifest_legKey_governmentSecurityInfo_get parameters: - name: legKey in: path required: true description: The manifest leg key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndListOfManifestLightPassengerGovernmentSecurityInfo' examples: Manifest Government Security Information Response: description: Example response for retrieving the manifest government security information. value: data: zzzzzz - recordLocator: - userKey: userKey personKey: PersonKey passengerAlternateKey: PassAltKey passengerKey: PassKey checkInType: 0 infant: nationality: US dateOfBirth: '2026-07-09T05:55:14.8702293+00:00' residentCountry: US gender: 2 name: first: infFirst middle: infMiddle last: infLast title: '' suffix: '' declaredGender: null name: first: first middle: Middle last: Last title: '' suffix: '' recordLocator: ZZZZZZ - RecordLocator bookingStatus: 2 passengerInformation: nationality: US residentCountry: US gender: 2 dateOfBirth: '2026-07-09T05:55:14.8704381+00:00' familyNumber: 1 declaredGender: null type: ADT bookingDate: '2026-07-09T05:55:14.8701628+00:00' isMissingVerifiedDocAdult: true isMissingVerifiedDocInfant: true passengerAddresses: - passengerAlternateKey: PassAltKey countryName: US lineOne: Address companyName: '' lineTwo: '' phone: '8885551234' lineThree: '' stationCode: SLC countryCode: US emailAddress: Yes@Yes.com provinceState: UT status: 1 city: SLC passengerAddressKey: PassKey postalCode: '88888' passengerTravelDocuments: - passengerTravelDocumentKey: PassTravDocKey documentTypeCode: P birthCountry: US issuedByCode: US name: first: First middle: Middle last: Last title: '' suffix: '' nationality: US expirationDate: '2026-07-10T05:55:14.8704662+00:00' number: '123456789' issuedDate: '2026-07-09T05:55:14.8704677+00:00' gender: 2 dateOfBirth: '2026-07-09T05:55:14.8704657+00:00' declaredGender: Female placeOfBirth: US placeOfIssue: US - passengerTravelDocumentKey: InfPassTravDocKey documentTypeCode: P birthCountry: US issuedByCode: US name: first: infFirst middle: infMiddle last: infLast title: '' suffix: '' nationality: US expirationDate: '2026-07-10T05:55:14.8704692+00:00' number: 123456789I issuedDate: '2026-07-09T05:55:14.8704694+00:00' gender: 2 dateOfBirth: '2026-07-09T05:55:14.8704691+00:00' declaredGender: Female placeOfBirth: US placeOfIssue: US passengerAddressRequirement: true profileStatus: 0 authorizationList: null deprecated: true /api/nsk/v2/manifest/{legKey}/governmentSecurityInfo: get: tags: - manifest summary: 'Retrieves the government security requirements for all passengers on the specified leg by calling the New Skies Government Security Service (GSS).' description: 'This endpoint is slower than other manifest endpoints because it requires synchronous communication with backend systems such as the Government Security Service (GSS) and the underlying New Skies remoting layer that brokers GSS calls. The `data.internationalFlight` property is only populated if there are passengers on the flight. The following response properties are only populated if the flight is international and already has passengers: - `data.arrivalCountry` - `data.departureCountry` This endpoint requires a session token and is agent-only. GraphQL endpoint: manifestGovernmentSecurityInformationv2' operationId: nsk_v2_manifest_legKey_governmentSecurityInfo_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfManifestLightGovernmentSecurityInfoResponse' examples: Manifest government security information response: description: Example response for retrieving the manifest government security information. This is only a sample response for NRT-SYD and values may differ depending on the GSS configuration. value: data: passengers: - userKey: userKey personKey: PersonKey passengerAlternateKey: PassAltKey passengerKey: PassKey checkInType: 0 infant: nationality: US dateOfBirth: '2026-07-09T05:55:14.8830757+00:00' residentCountry: US gender: 2 name: first: infFirst middle: infMiddle last: infLast title: '' suffix: '' declaredGender: null name: first: first middle: Middle last: Last title: '' suffix: '' recordLocator: ZZZZZZ - RecordLocator bookingStatus: 2 passengerInformation: nationality: US residentCountry: US gender: 2 dateOfBirth: '2026-07-09T05:55:14.8830797+00:00' familyNumber: 1 declaredGender: null type: ADT bookingDate: '2026-07-09T05:55:14.8830746+00:00' isMissingVerifiedDocAdult: true isMissingVerifiedDocInfant: true passengerAddresses: - passengerAlternateKey: PassAltKey countryName: US lineOne: Address companyName: '' lineTwo: '' phone: '8885551234' lineThree: '' stationCode: SLC countryCode: US emailAddress: Yes@Yes.com provinceState: UT status: 1 city: SLC passengerAddressKey: PassKey postalCode: '88888' passengerTravelDocuments: - passengerTravelDocumentKey: PassTravDocKey documentTypeCode: P birthCountry: US issuedByCode: US name: first: First middle: Middle last: Last title: '' suffix: '' nationality: US expirationDate: '2026-07-10T05:55:14.883082+00:00' number: '123456789' issuedDate: '2026-07-09T05:55:14.8830833+00:00' gender: 2 dateOfBirth: '2026-07-09T05:55:14.8830817+00:00' declaredGender: Female placeOfBirth: US placeOfIssue: US - passengerTravelDocumentKey: InfPassTravDocKey documentTypeCode: P birthCountry: US issuedByCode: US name: first: infFirst middle: infMiddle last: infLast title: '' suffix: '' nationality: US expirationDate: '2026-07-10T05:55:14.8830839+00:00' number: 123456789I issuedDate: '2026-07-09T05:55:14.883084+00:00' gender: 2 dateOfBirth: '2026-07-09T05:55:14.8830838+00:00' declaredGender: Female placeOfBirth: US placeOfIssue: US passengerAddressRequirement: true profileStatus: 0 authorizationList: null arrivalCountry: apisCheckDocuments: false apisRequiredInbound: false apisRequiredOutbound: false appsRequiredInbound: true appsRequiredOutbound: true countryCode: AU countryCode3C: AUS departureCountry: apisCheckDocuments: true apisRequiredInbound: true apisRequiredOutbound: true appsRequiredInbound: false appsRequiredOutbound: false countryCode: JP countryCode3C: JPN internationalFlight: true '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid leg key: description: The provided leg key is invalid and cannot be decoded correctly. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'legKey' with value 'MjM4Nzc5NjQ0MDAwMDAwMDAwIU5WITU2MDAhICFTTEMhQk9TITQ2ODAbc4+-' is invalid. type: Validation details: null rawMessage: The identifier 'legKey' with value 'MjM4Nzc5NjQ0MDAwMDAwMDAwIU5WITU2MDAhICFTTEMhQk9TITQ2ODAbc4+-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Leg key is null: description: The provided leg key is null. It can be set to null by setting it to a URL encoded space value `%20`. value: errors: - id: null code: core:Validation:RequiredArgument message: The request is missing a required argument expected in the request. type: Validation details: argument: legKey rawMessage: The request is missing a required argument expected in the request. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: No manifest government security information: description: No manifest government security information to be retrieved. This happens when there are no bookings with passengers for the specified leg. value: data: null '401': description: Authorization not allowed. Endpoint requires agent permissions. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Authentication token is missing or invalid: description: Example when the authentication token is missing or invalid. A token from a non-agent user is not valid. value: null /api/nsk/v2/manifest/{legKey}/passengerDetails: get: tags: - manifest summary: Gets the passenger details for the specified leg. description: 'GraphQL endpoint: manifestPassengerDetailsv2' operationId: nsk_v2_manifest_legKey_passengerDetails_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDetailsv2' examples: Manifest with Passenger Details: description: Successful retrieval of manifest with passenger details. value: data: passengers: - passengerAlternateKey: MjY0OTQ3 status: 2 recordLocator: ASDFGH createdDate: '2026-07-09T05:55:14.8957318Z' name: first: Justine middle: null last: Doe title: null suffix: null profileStatus: 0 infantTicketNumber: null weightCategory: 1 ticketNumber: null origin: SLC ticketIndicator: null destination: BOS ssrCodes: null tripType: 1 segmentBookingStatus: HK connectingFlight: null connectingStation: null finalDestination: BOS paymentMethods: - CA comments: null infant: nationality: null dateOfBirth: '2026-06-09T00:00:00+00:00' residentCountry: null gender: 1 name: first: Baby middle: null last: Doe title: null suffix: null declaredGender: null customerProgram: null verifiedReference: null guestValueLevel: null paidStatus: 1 - passengerAlternateKey: MjY0OTQ3 status: 2 recordLocator: ASDFGH createdDate: '2026-07-09T05:55:14.8957369Z' name: first: Justine middle: null last: Doe title: null suffix: null profileStatus: 0 infantTicketNumber: null weightCategory: 3 ticketNumber: null origin: SLC ticketIndicator: null destination: BOS ssrCodes: null tripType: 1 segmentBookingStatus: HK connectingFlight: null connectingStation: null finalDestination: BOS paymentMethods: - CA comments: null infant: null customerProgram: null verifiedReference: null guestValueLevel: null paidStatus: 1 - passengerAlternateKey: MjY0OTQ3 status: 1 recordLocator: QWERTY createdDate: '2026-07-09T05:55:14.8957372Z' name: first: Justine middle: null last: Doe title: null suffix: null profileStatus: 0 infantTicketNumber: null weightCategory: 2 ticketNumber: null origin: SLC ticketIndicator: null destination: BOS ssrCodes: null tripType: 1 segmentBookingStatus: HK connectingFlight: null connectingStation: null finalDestination: BOS paymentMethods: - CA comments: null infant: null customerProgram: null verifiedReference: null guestValueLevel: null paidStatus: 1 summary: totalConfirmedMales: 1 totalConfirmedFemales: 0 totalConfirmedChildren: 1 totalConfirmedInfants: 1 totalWaitListConfirmedMales: 0 totalWaitListConfirmedFemales: 0 totalWaitListConfirmedChildren: 0 totalWaitListConfirmedInfants: 0 totalUnconfirmedMales: 0 totalUnconfirmedFemales: 1 totalUnconfirmedChildren: 0 totalUnconfirmedInfants: 0 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid leg key: description: The provided leg key is invalid and cannot be decoded correctly. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'legKey' with value 'MjM4Nzc5NjQ0MDAwMDAwMDAwIU5WITU2MDAhICFTTEMhQk9TITQ2ODAbc4+-' is invalid. type: Validation details: null rawMessage: The identifier 'legKey' with value 'MjM4Nzc5NjQ0MDAwMDAwMDAwIU5WITU2MDAhICFTTEMhQk9TITQ2ODAbc4+-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '401': description: Authorization not allowed. Endpoint requires agent permissions. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Not allowed to retrieve manifest: description: The currently logged-in user is not authorized to retrieve the manifest with passenger details. Kindly enable the `Roles > Departure Control > Manifest with connection Information` and `Roles > Departure Control > Selectees by Flight` in the Management Console to successfully retrieve the manifest. value: errors: - id: null code: nsk-server:Authorization message: Agent not authorized to view the Manifest report type: Error details: null rawMessage: Agent not authorized to view the Manifest report exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/dcs/v1/manifest/{legKey}/passengerDetails/weightBalance: get: tags: - manifest summary: Gets the weight balance passenger details for the specified leg. description: 'GraphQL endpoint: passengerWeightBalance' operationId: dcs_v1_manifest_legKey_passengerDetails_weightBalance_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerWeightBalanceSummary' /api/nsk/v1/manifest/{legKey}/passengerSeatAssignments: get: tags: - manifest summary: Gets a list of seat assignment reports for the specified leg. description: 'GraphQL endpoint: manifestSeatAssignments' operationId: nsk_v1_manifest_legKey_passengerSeatAssignments_get parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerSeatAssignment' /api/nsk/v1/manifest/{legKey}/segments: get: tags: - manifest summary: Gets the manifest segment data for the specified leg. description: 'This structure of manifest data most closely resembles the original v2 manifest structure without the duplicate data and performance issues. GraphQL endpoint: manifestSegments' operationId: nsk_v1_manifest_legKey_segments_get parameters: - name: legKey in: path required: true description: The manifest leg key. schema: type: string x-position: 1 - name: includeNonOriginData in: query description: Include segments associated outside the requested leg. schema: type: boolean x-position: 2 - name: includeIATCILookAhead in: query description: Include IATCI look ahead data. Default is false. schema: type: boolean nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfManifestBySegment' examples: Manifest By Segment Response: description: Example response for retrieving the manifest by segment. value: data: market: identifier: identifier: '5600' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T05:55:14.8552008+00:00' externalIdentifier: identifier: '5600' carrierCode: NV opSuffix: null legs: - legNumber: 1 market: identifier: identifier: '5600' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T05:55:14.8552738+00:00' liftStatus: 2 manifestOrigin: true manifestLegKey: NjM4ODIzNDU2MDAwMDAwMDAwIU5WITU2MjUhICFERU4hU0xD passengers: - passengerAlternateKey: NDN2Lkb1 baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 cabinOfService: Y changeReasonCode: null classOfService: O fareBasisCode: OFDAPI productClassCode: FX seatProperties: - preferenceStatus: Y propertyCode: 'TRUE' propertyTypeCode: AISLE ticketIndicator: null ticketNumber: null upgradeIndicator: false verifiedTravelDocs: null legs: - boardingSequence: 1 boardingZone: 99 compartmentDesignator: F priorityCode: null priorityDate: '2026-07-09T05:55:14.8555736+00:00' promptToVerifyId: false unitAssignmentWeight: 0 unitDesignator: 2B manifestUnitKey: null liftStatus: 2 - boardingSequence: 1 boardingZone: 99 compartmentDesignator: F priorityCode: null priorityDate: '2026-07-09T05:55:14.855658+00:00' promptToVerifyId: false unitAssignmentWeight: 0 unitDesignator: 2B manifestUnitKey: null liftStatus: 0 passengerSegmentOrderNumber: 0 ticketFareBasis: null manifestSegmentKey: NjM4ODIzNDU2MDAwMDAwMDAwIU5WITU2MjUhICFERU4hU0xD /api/nsk/v1/manifest/{legKey}/ssrs: get: tags: - manifest summary: Gets the manifest SSRs for the specified leg. description: 'GraphQL endpoint: manifestSsrs' operationId: nsk_v1_manifest_legKey_ssrs_get parameters: - name: legKey in: path required: true description: The manifest leg key. schema: type: string x-position: 1 - name: includeNonOriginSsrs in: query description: Include SSRs associated to other legs or segments from the requested leg. schema: type: boolean x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfManifestSsr' /api/nsk/v1/messages: post: tags: - messages summary: Adds a new message item. description: 'GraphQL endpoint: messageAddv2' operationId: nsk_v1_messages_post requestBody: x-name: request description: The message queue. content: application/json: schema: $ref: '#/components/schemas/MessageBase' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - messages summary: Deletes a collection of message items. description: 'This endpoint does not perform additional verification that the messages were deleted. As long as there are no errors or exceptions, the delete operation is considered successful. A separate call to the GET `/api/nsk/v1/messages` endpoint can be made to verify that all the specified messages do not exist anymore. GraphQL endpoint: messagesDelete' operationId: nsk_v1_messages_delete requestBody: x-name: messageKeys description: The collection of message keys to delete. content: application/json: schema: type: array items: type: string required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/messages: get: tags: - messages summary: Retrieves a collection of teletype messages based on search criteria. description: 'GraphQL endpoint: messagesSearchv2' operationId: nsk_v2_messages_get parameters: - name: LastPageKey in: query description: "The key of the last item returned from paging.\n " schema: type: string nullable: true x-position: 1 - name: MessageQueueFilter in: query description: "The filter that specifies which records to retrieve.\n \ \ \nEnumeration values: 0 = NonHiddenRecords, 1 = HiddenRecords,\ \ 2 = All" schema: $ref: '#/components/schemas/MessageQueueHiddenOptions' x-position: 2 - name: MessageTypeCode in: query description: "The message type code to search for.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 3 - name: SearchStartDate in: query description: "The start of created date range to search for.\n " schema: type: string format: date-time nullable: true x-position: 4 - name: SearchEndDate in: query description: "The end of created date range to search for.\n " schema: type: string format: date-time nullable: true x-position: 5 - name: PageSize in: query description: "The number of records to return when paging.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 6 - name: SearchValue in: query description: "The search query.\n " schema: type: string maxLength: 64 minLength: 0 nullable: true x-position: 7 - name: SearchType in: query description: "The type of search to be performed.\n \nEnumeration\ \ values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" schema: $ref: '#/components/schemas/SearchType' x-position: 8 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMessagesSearchResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/messages/{messageKey}: get: tags: - messages summary: Retrieves a specific message item. description: 'GraphQL endpoint: messages' operationId: nsk_v1_messages_messageKey_get parameters: - name: messageKey in: path required: true description: The key of the message to be retrieved. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMessageResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - messages summary: Deletes a message item. description: 'GraphQL endpoint: messageDeletev2' operationId: nsk_v1_messages_messageKey_delete parameters: - name: messageKey in: path required: true description: The key of the message to delete. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/messages/teletype: post: tags: - messages summary: Sends a new generic teletype message to the specified address in the request. description: 'GraphQL endpoint: teletypeMessageAdd' operationId: nsk_v1_messages_teletype_post requestBody: x-name: request description: The generic teletype message request. content: application/json: schema: $ref: '#/components/schemas/GenericTeletypeMessageRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/messages/teletype/tcp/{recordLocator}: post: tags: - messages summary: Sends a well-formed TCP formatted teletype message to the appropriate booking segments. description: 'For carriers that are Amadeus Reservation Gateway (ARG) participants, this agent-only endpoint provides the option to push a PNR to Amadeus on a PNR-by-PNR basis using the TCP push functionality. When a booking containing a TCP-qualifying segment is retrieved (marketing codeshare and normal unflown segments), and the TCP Push functionality is used, the system then sends an "Unsolicited Transfer PNR" (TCP) message to the configured external system. TCP messages can be configured using the Management Console > External Message Settings screen. Related Endpoints: - `GET /api/nsk/v1/booking/history/message`: View the history of TCP messages sent. - `POST /api/nsk/v1/messages/teletype`: This endpoint sends a teletype message with the specified text. GraphQL endpoint: tcpMessagePush' operationId: nsk_v1_messages_teletype_tcp_recordLocator_post parameters: - name: recordLocator in: path required: true description: The record locator, which uniquely identifies a booking. Common referred to as PNR. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: TCP Message Sent: description: The TCP message was sent. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Record Locator: description: The record locator provided is null, empty, exceeded the maximum length, or the booking associated with the record locator is not found. value: errors: - id: null code: nsk:Booking:InvalidRecordLocator message: The record locator PNRPNR is not valid. type: Validation details: recordLocator: PNRPNR rawMessage: The record locator PNRPNR is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Unqualified Segments: description: The booking does not contain any TCP qualified segments. value: errors: - id: null code: nsk:Messages:TcpMessageNotSent message: PNR doesn't contain any TCP qualified segments. type: Error details: null rawMessage: PNR doesn't contain any TCP qualified segments. 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. With Ineligible Booking: description: The system code of the booking is not configured on the TCP's receiving system. value: errors: - id: null code: nsk:Messages:TcpMessageNotSent message: PNR Not Eligible for TCP Push. type: Error details: null rawMessage: PNR Not Eligible for TCP Push. 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. With Agent Restricted to Push TCP Messages: description: The agent is not allowed to push TCP messages. Please see Roles > SkySpeed > Allow TCP on Demand in the Management Console. value: errors: - id: null code: nsk:Messages:TcpMessageNotSent message: Agent is not allowed to use the requested API. RoleCode='TAW3', API Permission='TCPOnDemand' AccessControl='Read' Channel='Default'. type: Error details: null rawMessage: Agent is not allowed to use the requested API. RoleCode='TAW3', API Permission='TCPOnDemand' AccessControl='Read' Channel='Default'. 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. With TCP Not Configured: description: The TCP is not configured in Management Console. This can be configured under the External Message Settings. value: errors: - id: null code: nsk:Messages:TcpMessageNotSent message: TCP On Demand Not Configured. type: Error details: null rawMessage: TCP On Demand Not Configured. 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. With External System Interaction Not Setup: description: The carrier code of the booking is not setup for external system interaction. This can be configured under External Message Settings. value: errors: - id: null code: nsk:Messages:TcpMessageNotSent message: "Failed to send TCP Push: \nReason TCP message to 1A\ \ failed, Reason External System interaction is not setup\ \ for GN to BS Interaction Purpose." type: Error details: null rawMessage: "Failed to send TCP Push: \nReason TCP message to\ \ 1A failed, Reason External System interaction is not setup\ \ for GN to BS Interaction Purpose." 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. Unable to retrieve the System Booking Configuration: description: The system booking configuration cannot be retrieved. value: errors: - id: null code: nsk:Messages:TcpMessageNotSent message: 'Failed To send TCP Push: Reason system Booking config {0} cannot be retrieved' type: Error details: null rawMessage: 'Failed To send TCP Push: Reason system Booking config {0} cannot be retrieved' 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. Exception occurred in the ESC Service: description: ESC Services encountered an exception value: errors: - id: null code: nsk:Messages:TcpMessageNotSent message: 'Failed to send TCP Push: Reason ESC Services encountered an exception' type: Error details: null rawMessage: 'Failed to send TCP Push: Reason ESC Services encountered an exception' 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. '401': description: This endpoint require agent permissions. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/oneTimeTravelNotifications: post: tags: - oneTimeTravelNotifications summary: Creates a one time travel notification. description: 'To get or delete a one time notification, you will need to store the key that is on the location header. GraphQL endpoint: oneTimeTravelNotificationAdd' operationId: nsk_v1_oneTimeTravelNotifications_post requestBody: x-name: request description: The passenger travel notification create request. content: application/json: schema: $ref: '#/components/schemas/OneTimeNotificationCreateRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/oneTimeTravelNotifications: post: tags: - oneTimeTravelNotifications summary: Creates a one time travel notification. description: 'GraphQL endpoint: oneTimeTravelNotificationAddv2' operationId: nsk_v2_oneTimeTravelNotifications_post requestBody: x-name: request description: The one time travel notification create request. content: application/json: schema: $ref: '#/components/schemas/OneTimeNotificationCreateRequest' examples: Create One Time Travel Notification: description: Example request when creating a one time travel notification. value: events: - type: 0 cultureCode: en-US timedEvents: - minutesToEvent: 10 type: 0 notificationDestination: deliveryMethodCode: 0 destination: example@gmail.com marketInformation: identifier: identifier: '5611' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.4374112Z' deviceName: null Create One Time Travel Notification With Events Only: description: Example request when creating a one time travel notification with events only. value: events: - type: 0 cultureCode: en-US timedEvents: null notificationDestination: deliveryMethodCode: 0 destination: example@gmail.com marketInformation: identifier: identifier: '5611' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.4374234Z' deviceName: null Create One Time Travel Notification With Timed Events Only: description: Example request when creating a one time travel notification with timed events only. value: events: null cultureCode: en-US timedEvents: - minutesToEvent: 10 type: 0 notificationDestination: deliveryMethodCode: 0 destination: example@gmail.com marketInformation: identifier: identifier: '5611' carrierCode: NV opSuffix: null destination: BOS origin: SLC departureDate: '2026-07-09T05:55:13.437424Z' deviceName: null required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid E-mail Address: description: Example response when e-mail address is invalid value: errors: - id: 63dd49c7-59f7-5a0c-d07a-d249785314e9 code: nsk-server:InvalidEmailAddress message: nsk-server:InvalidEmailAddress type: Validation details: message: '@gmail.com is not a valid email address.' rawMessage: '@gmail.com is not a valid email address.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Phone Number: description: Example response when phone number is invalid value: errors: - id: 63dd49c7-59f7-5a0c-d07a-d249785314e9 code: nsk-server:InvalidPhoneNumber message: nsk-server:InvalidPhoneNumber type: Validation details: message: ABD is not a valid email phone number. rawMessage: ABD is not a valid email phone number. 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 Null Notification Destination: description: Example response when creating a one time travel notification with a null or empty notification destination. value: errors: - id: ca448f1f-9dae-afa8-bc79-423a6aaa9c56 code: nsk:TravelNotification:NullDestination message: nsk:TravelNotification:NullDestination type: Validation details: null rawMessage: The destination of the subscription should not be blank. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Device Name for Push Notification: description: Example response when creating a one time travel notification with an invalid device name for push notification value: errors: - id: 6ac6116b-85f8-f47d-f100-99338b6f8287 code: nsk:DeviceName:InvalidDeviceName message: nsk:DeviceName:InvalidDeviceName type: Validation details: null rawMessage: The device name should be set for notification of type Push exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Device Name for Email and Phone Notification: description: Example response when creating a one time travel notification with a device name that should not be set for email and phone notifications value: errors: - id: 6ac6116b-85f8-f47d-f100-99338b6f8287 code: nsk:DeviceName:InvalidDeviceName message: nsk:DeviceName:InvalidDeviceName type: Validation details: null rawMessage: The device name should not be set for notification of type Email 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 Empty Event Type: description: Example response when creating a one time travel notification with an empty event type value: errors: - id: 135f4684-f240-3988-e042-69aad6e5cce4 code: OneTimeNotificationEventCreateRequest.Type:RequiredAttribute message: OneTimeNotificationEventCreateRequest.Type:RequiredAttribute type: Validation details: validation: RequiredAttribute model: OneTimeNotificationEventCreateRequest member: Type rawMessage: The OneTimeNotificationEventCreateRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Empty Timed Event Type: description: Example response when creating a one time travel notification with an empty timed event type value: errors: - id: 6214d832-864c-a521-1e31-c24190043349 code: NotificationTimedEventCreateRequest.Type:RequiredAttribute message: NotificationTimedEventCreateRequest.Type:RequiredAttribute type: Validation details: validation: RequiredAttribute model: NotificationTimedEventCreateRequest member: Type rawMessage: The NotificationTimedEventCreateRequest field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Minutes to Event: description: Example response when creating a one time travel notification with an invalid minutes to event value value: errors: - id: d9f64797-ec60-93fb-dfe4-4bf4c0c94dd5 code: nsk:MinutesToEvent:InvalidMinutesToEventValue message: nsk:MinutesToEvent:InvalidMinutesToEventValue type: Validation details: minutesToEvent: '5' rawMessage: The minutes to event value of '5' is invalid for timed notification even type 'Arrival'. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Event Type: description: Example response when creating a one time travel notification with an invalid event type value: errors: - id: d48df503-4c4d-30a8-0862-a3e03b0cbb1f code: nsk:NotificationEvent:InvalidEventType message: nsk:NotificationEvent:InvalidEventType type: Validation details: eventType: '2' rawMessage: The event type '2' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Timed Event Type: description: Example response when creating a one time travel notification with an invalid timed event type value: errors: - id: b1c5c484-0f33-f847-82d8-28aedb3975c2 code: nsk:NotificationEvent:InvalidTimedEventType message: nsk:NotificationEvent:InvalidTimedEventType type: Validation details: timedEventType: '2' rawMessage: The timed event type '2' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Empty Subscription Events List: description: Example response when the list of subscription events are empty. value: errors: - id: 7e18d08c-bbbc-2d2f-6c2b-9456d84670ac code: nsk:NotificationEvent:NullEvents message: nsk:NotificationEvent:NullEvents type: Validation details: null rawMessage: The list of subscription events should not be empty. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Culture Code: description: Example response when the culture code is invalid. value: errors: - id: 20c566a3-e928-1afb-edd6-b9725789060b code: nsk:TravelNotification:InvalidCultureCode message: nsk:TravelNotification:InvalidCultureCode type: Validation details: cultureCode: dn-US rawMessage: The culture code dn-US is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Existing Notification: description: Example response when a one time travel notification already exists when creating with the same destination address. value: errors: - id: 70c46bde-ece4-508c-ce33-c59f652038ae code: nsk-server:SubscriptionCommitFailed message: nsk-server:SubscriptionCommitFailed type: Error details: null rawMessage: Request already received for 20240408 NV5611 SLCBOS with email1@test.com; email2@test.com. If an update is required, please cancel the original request. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Market Information: description: Example response when the market information is invalid. value: errors: - id: a0c9c3ac-f0a0-a1de-cb55-2696fc0c8562 code: nsk-server:WarningException message: nsk-server:WarningException type: Error details: null rawMessage: 'The flight being subscribed to (20240415 NV 561 SLCBOS) cannot be found ' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/oneTimeTravelNotifications/{oneTimeTravelNotificationKey}: get: tags: - oneTimeTravelNotifications summary: Gets a one time travel notification. description: 'GraphQL endpoint: oneTimeTravelNotification' operationId: nsk_v1_oneTimeTravelNotifications_oneTimeTravelNotificationKey_get parameters: - name: oneTimeTravelNotificationKey in: path required: true description: The one time travel notification key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOneTimeTravelNotification' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true delete: tags: - oneTimeTravelNotifications summary: Deletes a one time travel notification. description: 'GraphQL endpoint: oneTimeTravelNotificationDelete' operationId: nsk_v1_oneTimeTravelNotifications_oneTimeTravelNotificationKey_delete parameters: - name: oneTimeTravelNotificationKey in: path required: true description: The one time travel notification key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/oneTimeTravelNotifications/{subscriptionNumber}: get: tags: - oneTimeTravelNotifications summary: Gets a one time travel notification through a subscription number. description: 'GraphQL endpoint: oneTimeTravelNotificationv2' operationId: nsk_v2_oneTimeTravelNotifications_subscriptionNumber_get parameters: - name: subscriptionNumber in: path required: true description: The subscription number. schema: type: string x-position: 1 - name: destination in: query description: The notification destination. schema: type: string nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOneTimeTravelNotificationv2' examples: Retrieve One Time Travel Notification Response: description: Example response for successfully retrieving a One Time Travel Notification by Subscription Number value: data: expirationDate: '2026-07-12T05:55:13.4474207Z' cultureCode: US subscriptionNumber: '446776225723' notificationDestination: deliveryMethodCode: 0 destination: test@gmail.com deviceName: null events: - createdDate: '2026-07-09T05:55:13.447497Z' type: 0 timedEvents: - createdDate: '2026-07-09T05:55:13.4475512Z' minutesToEvent: 10 type: 0 marketInformation: identifier: identifier: '5611' carrierCode: NV opSuffix: null destination: SLC origin: BOS departureDate: '2026-07-10T05:55:13.4475766Z' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - oneTimeTravelNotifications summary: Deletes a one time travel notification through a subscription number. description: 'GraphQL endpoint: oneTimeTravelNotificationDeletev2' operationId: nsk_v2_oneTimeTravelNotifications_subscriptionNumber_delete parameters: - name: subscriptionNumber in: path required: true description: The subscription number. schema: type: string x-position: 1 - name: destination in: query description: The notification destination. schema: type: string nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Subscription number not found: description: Example response when the subscription number is not found value: errors: - id: 04c4da13-bb82-1816-8a4a-c3ef561516e7 code: nsk:TravelNotification:SubscriptionNumberNotFound message: nsk:TravelNotification:SubscriptionNumberNotFound type: Validation details: null rawMessage: The subscription number could not be found. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v2/organizationGroup: post: tags: - organizationGroup summary: Creates a new organization group and adds an organization to it. description: 'GraphQL endpoint: organizationGroupAddv2' operationId: nsk_v2_organizationGroup_post requestBody: x-name: request description: The organization group create request. content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupCreateRequest' examples: Organization Group Create Request: description: Creates a new organization group value: organizationGroupCode: ABC organizationGroupName: Group Name organization: organizationCode: AAA name: Organization Name required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationGroupDetails' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizationGroups/{organizationGroupCode}: post: tags: - organizationGroups summary: Creates a new organization group. description: 'GraphQL endpoint: organizationGroupAdd' operationId: nsk_v1_organizationGroups_organizationGroupCode_post parameters: - name: organizationGroupCode in: path required: true description: The ID of the organization group to create. schema: type: string x-position: 1 requestBody: x-name: request description: The information for adding the organization group. content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupRequest' required: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationGroupDetails' deprecated: true put: tags: - organizationGroups summary: Modifies an organization group by updating the group name or adding an organization to the organization group. description: 'GraphQL endpoint: organizationGroupSet' operationId: nsk_v1_organizationGroups_organizationGroupCode_put parameters: - name: organizationGroupCode in: path required: true description: The organization group code to modify. schema: type: string x-position: 1 requestBody: x-name: request description: The request for the update. content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupRequest' required: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupDetails' delete: tags: - organizationGroups summary: 'Deletes an organization group. This should not be used if the organization group needs to exist.' description: 'GraphQL endpoint: organizationGroupDelete' operationId: nsk_v1_organizationGroups_organizationGroupCode_delete parameters: - name: organizationGroupCode in: path required: true description: The organization group code to delete. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizationGroups/{organizationGroupCode}/organizations: put: tags: - organizationGroups summary: Updates an organization group by removing all organizations description: 'GraphQL endpoint: organizationGroupOrganizationRemoveAll' operationId: nsk_v1_organizationGroups_organizationGroupCode_organizations_put parameters: - name: organizationGroupCode in: path required: true description: The organization group code to remove all organizations from. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupDetails' /api/nsk/v1/organizationGroups/{organizationGroupCode}/organizations/{organizationCode}: put: tags: - organizationGroups summary: Updates an organization group by removing an organization description: 'GraphQL endpoint: organizationGroupOrganizationRemove' operationId: nsk_v1_organizationGroups_organizationGroupCode_organizations_organizationCode_put parameters: - name: organizationGroupCode in: path required: true description: The organization group code to modify. schema: type: string x-position: 1 - name: organizationCode in: path required: true description: The organization code to remove from the group. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/OrganizationGroupDetails' /api/nsk/v1/organizations/groups: get: tags: - organizations summary: Retrieves the organization groups. description: 'GraphQL endpoint: organizationGroups' operationId: nsk_v1_organizations_groups_get responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfOrganizationGroup' /api/nsk/v1/organizations/groups/{organizationGroupCode}: get: tags: - organizations summary: Retrieves the details of an organization group. description: 'GraphQL endpoint: organizationGroup' operationId: nsk_v1_organizations_groups_organizationGroupCode_get parameters: - name: organizationGroupCode in: path required: true description: The organization group code to retrieve. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationGroupDetails' /api/nsk/v1/organizations2: post: tags: - organizations2 summary: Create a new organization. description: 'Requires agent permissions. The organization code is a generic code for all of the organization types. Each individual type has its own code and validation. If the organization status is not pending the organization code should follow these validation rules based on type: Third Party: 3 to 10 characters in length with alphanumeric values. Travel Agency: 7 to 10 characters in length with numeric values. Carrier: 2 to 3 characters in length with alphanumeric values. If no organization code is provided then one will be generated and returned on the header. GraphQL endpoint: organizationAdd' operationId: nsk_v1_organizations2_post requestBody: x-name: createRequest description: The request for creating the new organization. content: application/json: schema: $ref: '#/components/schemas/OrganizationCreateRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/organizations2: get: tags: - organizations2 summary: Searches for organizations. description: 'GraphQL endpoint: organizations2v2' operationId: nsk_v2_organizations2_get parameters: - name: OrganizationCode in: query description: "The organization code.\n " schema: type: string maxLength: 10 minLength: 2 nullable: true x-position: 1 - name: Type in: query description: "Organization type.\n \nEnumeration values: 0 = Default,\ \ 1 = Master, 2 = Carrier, 3 = TravelAgency, 4 = ThirdParty" schema: $ref: '#/components/schemas/OrganizationType' x-position: 2 - name: Status in: query description: "The organization status.\n \nEnumeration values:\ \ 0 = Default, 1 = Active, 2 = Cancelled, 3 = Pending" schema: $ref: '#/components/schemas/OrganizationStatus' x-position: 3 - name: ParentOrganizationCode in: query description: "The parent organization code.\n " schema: type: string maxLength: 10 minLength: 2 nullable: true x-position: 4 - name: CompanyName in: query description: "The organization company name.\n " schema: type: string nullable: true x-position: 5 - name: City in: query description: "The organization company city.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 6 - name: PostalCode in: query description: "The organization company postal code.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 7 - name: PagedItemIndex in: query description: "Used to specify the index for skipping values when paging.\n\ \ " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 1.0 nullable: true x-position: 8 - name: PageSize in: query description: "Used to specify the maximum results to return.\n " schema: type: integer maximum: 5000.0 minimum: 1.0 nullable: true x-position: 9 - name: MatchCriteria.OrganizationCode in: query description: "The type of string search for organization code.\n \ \ \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3\ \ = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 10 - name: MatchCriteria.ParentOrganizationCode in: query description: "The type of string search for parent organization code.\n \ \ \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains,\ \ 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 11 - name: MatchCriteria.CompanyName in: query description: "The type of string search for organization company name.\n\ \ \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains,\ \ 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 12 - name: MatchCriteria.City in: query description: "The type of string search for organization company city.\n\ \ \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains,\ \ 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 13 - name: MatchCriteria.PostalCode in: query description: "The type of string search for organization company postal code.\n\ \ \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains,\ \ 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 14 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfOrganizationRecord' /api/nsk/v1/organizations2/{organizationCode}: get: tags: - organizations2 summary: Retrieves the organization. description: 'GraphQL endpoint: organization2' operationId: nsk_v1_organizations2_organizationCode_get parameters: - name: organizationCode in: path required: true description: The identifier of the organization to update. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationv2' put: tags: - organizations2 summary: Updates an organization. description: 'Requires agent permissions. The organization code is a generic code for all of the organization types. Each individual type has its own code and validation. If the organization status is not pending the organization code should follow these validation rules based on type: Third Party: 3 to 10 characters in length with alphanumeric values. Travel Agency: 7 to 10 characters in length with numeric values. Carrier: 2 to 3 characters in length with alphanumeric values. GraphQL endpoint: organizationSet' operationId: nsk_v1_organizations2_organizationCode_put parameters: - name: organizationCode in: path required: true description: The identifier for the organization to be updated. schema: type: string x-position: 1 requestBody: x-name: request description: The request for the update. content: application/json: schema: $ref: '#/components/schemas/OrganizationEditRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - organizations2 summary: Updates an organization. description: 'Requires agent permissions. The organization code is a generic code for all of the organization types. Each individual type has its own code and validation. If the organization status is not pending the organization code should follow these validation rules based on type: Third Party: 3 to 10 characters in length with alphanumeric values. Travel Agency: 7 to 10 characters in length with numeric values. Carrier: 2 to 3 characters in length with alphanumeric values. GraphQL endpoint: organizationModify' operationId: nsk_v1_organizations2_organizationCode_patch parameters: - name: organizationCode in: path required: true description: The identifier of the organization to update. schema: type: string x-position: 1 requestBody: x-name: createRequest description: The request containing the updates for the organization. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfOrganizationEditRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/account: get: tags: - organizations2 summary: Retrieves the organization account and collections based on the organization code. description: 'GraphQL endpoint: organizations2Account' operationId: nsk_v1_organizations2_organizationCode_account_get parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationAccount' post: tags: - organizations2 summary: Creates an organization account based on the organization code. description: 'GraphQL endpoint: organizations2AccountAdd' operationId: nsk_v1_organizations2_organizationCode_account_post parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 requestBody: x-name: request description: The create organization account request. content: application/json: schema: $ref: '#/components/schemas/CreateOrganizationAccountRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/account/childAccountTransactions: post: tags: - organizations2 summary: Adjust the available amount of a child account. description: 'The known list of parent-child relations are as follows: - Dependent accounts are not supported. - A parent''s account of type credit may have children of type supplemental or credit. - A parent''s account of type prepaid may have children of type prepaid. - No other combination of parent-child relations are supported. GraphQL endpoint: childAccountTransactionsAdd' operationId: nsk_v1_organizations2_organizationCode_account_childAccountTransactions_post parameters: - name: organizationCode in: path required: true description: The account reference number for the child organization. schema: type: string x-position: 1 requestBody: x-name: request description: The child account transaction request. content: application/json: schema: $ref: '#/components/schemas/ChildAccountTransactionsRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - organizations2 summary: Adjust the credit limit of a child account. description: 'The known list of parent-child relations are as follows: - Dependent accounts are not supported. - A parent''s account of type credit may have children of type supplemental or credit. - A parent''s account of type prepaid may have children of type prepaid. - No other combination of parent-child relations are supported. GraphQL endpoint: childAccountTransactionsSet' operationId: nsk_v1_organizations2_organizationCode_account_childAccountTransactions_put parameters: - name: organizationCode in: path required: true description: The account reference number for the child organization. schema: type: string x-position: 1 requestBody: x-name: request description: The child account transaction request. content: application/json: schema: $ref: '#/components/schemas/ChildAccountTransactionsRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/account/status: put: tags: - organizations2 summary: Updates the organization account status. description: 'GraphQL endpoint: organizations2AccountStatusSet' operationId: nsk_v1_organizations2_organizationCode_account_status_put parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 - name: status in: query description: "The allowed account status. \nEnumeration values: 0 = Open,\ \ 1 = Closed, 2 = AgencyInactive, 3 = Unknown" schema: $ref: '#/components/schemas/AccountStatus' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/account/transactions: get: tags: - organizations2 summary: 'Retrieves the organization account transactions based on the organization code and data in the request.' description: 'GraphQL endpoint: organizations2Transactions' operationId: nsk_v1_organizations2_organizationCode_account_transactions_get parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 - name: StartTime in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 2 - name: EndTime in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n \ \ " schema: type: integer format: int64 nullable: true x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTransaction' examples: Retrieve Transactions Response: description: Example response for retrieving transactions. value: data: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3583433Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. 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 deprecated: true post: tags: - organizations2 summary: 'Creates account transactions based on data in the request and the organization code.' description: 'GraphQL endpoint: organizations2TransactionsAdd' operationId: nsk_v1_organizations2_organizationCode_account_transactions_post parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 requestBody: x-name: request description: The transaction request. content: application/json: schema: $ref: '#/components/schemas/OrganizationTransactionRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/organizations2/{organizationCode}/account/transactions: get: tags: - organizations2 summary: Retrieves the organization account transactions based on the organization code and data in the request. description: 'GraphQL endpoint: organizations2Transactionsv2' operationId: nsk_v2_organizations2_organizationCode_account_transactions_get parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 - name: StartDate in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 2 - name: EndDate in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: string nullable: true x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedTransactionResponse' examples: Retrieve Transactions Successful: description: Example response for a successful retrieval of transactions. value: data: totalCount: 11085 lastPageKey: MTAw transactions: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.388568Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: End of paged results. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: End of paged results: description: 404 no content can be returned when there is no data or all data is filtered out such as when there is no more paged results. value: data: null /api/nsk/v1/organizations2/{organizationCode}/allotments/contracts: get: tags: - organizations2 summary: Retrieves all allotment contracts for the specified organization. description: 'GraphQL endpoint: allotmentContracts' operationId: nsk_v1_organizations2_organizationCode_allotments_contracts_get parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAllotmentContractResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - organizations2 summary: Creates the specified allotment contract. description: 'GraphQL endpoint: allotmentContractAdd' operationId: nsk_v1_organizations2_organizationCode_allotments_contracts_post parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 requestBody: x-name: request description: The allotment contract to create. content: application/json: schema: $ref: '#/components/schemas/AllotmentContractRequest' examples: Allotment contract request: description: Updates the current user's password with the new provided one. value: contractCode: ABC description: Travel agency contract status: 1 discontinueDate: '2026-07-09T05:55:16.1780894Z' contractProperties: - contractPropertyCode: ABC value: Test required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Error response for no request.: description: Only returns raw message in debug mode. value: errors: - id: null code: core:Validation:RequiredArgument message: null type: Error details: null rawMessage: The request is missing a required argument expected in the request. 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 Error response for when that status is default (0).: description: Only returns raw message in debug mode. value: errors: - id: null code: nsk-server:AllotmentContractStatusInvalid message: null type: Error details: null rawMessage: '''Default'' is not a valid status for a Contract.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/organizations2/{organizationCode}/allotments/contracts/{contractCode}: put: tags: - organizations2 summary: Updates the specified allotment contract. description: 'GraphQL endpoint: allotmentContractSet' operationId: nsk_v1_organizations2_organizationCode_allotments_contracts_contractCode_put parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 - name: contractCode in: path required: true description: The contract code. schema: type: string x-position: 2 requestBody: x-name: request description: The allotment contract to create. content: application/json: schema: $ref: '#/components/schemas/AllotmentContractUpdateRequest' examples: Allotment contract request: description: Updates the current user's password with the new provided one. value: contractCode: ABC description: Travel agency contract status: 1 discontinueDate: '2026-07-09T05:55:16.1807784Z' contractProperties: - contractPropertyCode: ABC value: Test required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Error response for no request.: description: Only returns raw message in debug mode. value: errors: - id: null code: core:Validation:RequiredArgument message: null type: Error details: null rawMessage: The request is missing a required argument expected in the request. 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 Error response for when that status is default (0).: description: Only returns raw message in debug mode. value: errors: - id: null code: nsk-server:AllotmentContractStatusInvalid message: null type: Error details: null rawMessage: '''Default'' is not a valid status for a Contract.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/organizations2/{organizationCode}/commissionRates: post: tags: - organizations2 summary: Create a commission rate. description: 'GraphQL endpoint: organizationCommissionRateAdd' operationId: nsk_v1_organizations2_organizationCode_commissionRates_post parameters: - name: organizationCode in: path required: true description: The organization group code to create a commission rate for. schema: type: string x-position: 1 requestBody: x-name: request description: The organization commission rate request. content: application/json: schema: $ref: '#/components/schemas/OrganizationCommissionRate' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/commissionRates/{commissionRateCode}: get: tags: - organizations2 summary: Get a commission rate. description: Get a commission rate. operationId: nsk_v1_organizations2_organizationCode_commissionRates_commissionRateCode_get parameters: - name: organizationCode in: path required: true description: The organization group code to retrieve commission rates for. schema: type: string x-position: 1 - name: commissionRateCode in: path required: true description: The commission rate code to retrieve. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationCommissionRate' delete: tags: - organizations2 summary: Delete a commission rate. description: 'GraphQL endpoint: organizationCommissionRateDelete' operationId: nsk_v1_organizations2_organizationCode_commissionRates_commissionRateCode_delete parameters: - name: organizationCode in: path required: true description: The organization group code to delete commission rates for. schema: type: string x-position: 1 - name: commissionRateCode in: path required: true description: The commission rate code to delete. schema: type: string x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/company/phoneNumbers: post: tags: - organizations2 summary: Create a company phone number. description: 'GraphQL endpoint: organizationCompanyPhoneAdd' operationId: nsk_v1_organizations2_organizationCode_company_phoneNumbers_post parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the phone number. schema: type: string x-position: 1 requestBody: x-name: request description: The data to update. content: application/json: schema: $ref: '#/components/schemas/PhoneNumber' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/company/phoneNumbers/{phoneNumberType}: put: tags: - organizations2 summary: Updates a company phone number. description: 'GraphQL endpoint: organizationCompanyPhoneSet' operationId: nsk_v1_organizations2_organizationCode_company_phoneNumbers_phoneNumberType_put parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the phone number. schema: type: string x-position: 1 - name: phoneNumberType in: path required: true description: "The phone number type of the phone number to update. \nEnumeration\ \ values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 requestBody: x-name: request description: The data to update. content: application/json: schema: $ref: '#/components/schemas/PhoneNumberBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - organizations2 summary: Deletes a company phone number. description: 'GraphQL endpoint: organizationCompanyPhoneDelete' operationId: nsk_v1_organizations2_organizationCode_company_phoneNumbers_phoneNumberType_delete parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the phone number. schema: type: string x-position: 1 - name: phoneNumberType in: path required: true description: "The phone number type of the phone number to delete. \nEnumeration\ \ values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/contact/phoneNumbers: post: tags: - organizations2 summary: Create a contact phone number. description: 'GraphQL endpoint: organizationContactPhoneAdd' operationId: nsk_v1_organizations2_organizationCode_contact_phoneNumbers_post parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the contact. schema: type: string x-position: 1 requestBody: x-name: request description: The request for the update. content: application/json: schema: $ref: '#/components/schemas/PhoneNumber' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/contact/phoneNumbers/{phoneNumberType}: put: tags: - organizations2 summary: Updates a contact phone number. description: 'GraphQL endpoint: organizationContactPhoneSet' operationId: nsk_v1_organizations2_organizationCode_contact_phoneNumbers_phoneNumberType_put parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the contact. schema: type: string x-position: 1 - name: phoneNumberType in: path required: true description: "The type of the phone number being updated. \nEnumeration values:\ \ 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 requestBody: x-name: request description: The request for updating the phone number. content: application/json: schema: $ref: '#/components/schemas/PhoneNumberBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - organizations2 summary: Deletes a contact phone number. description: 'GraphQL endpoint: organizationContactPhoneDelete' operationId: nsk_v1_organizations2_organizationCode_contact_phoneNumbers_phoneNumberType_delete parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the contact. schema: type: string x-position: 1 - name: phoneNumberType in: path required: true description: "The type of the phone number being deleted. \nEnumeration values:\ \ 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/externalAccounts: post: tags: - organizations2 summary: Create an external account. description: 'GraphQL endpoint: organizationExternalAccountAdd' operationId: nsk_v1_organizations2_organizationCode_externalAccounts_post parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the account. schema: type: string x-position: 1 requestBody: x-name: request description: The request containing the information for the account. content: application/json: schema: $ref: '#/components/schemas/OrganizationExternalAccountRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/externalAccounts/{externalAccountKey}: get: tags: - organizations2 summary: Get an external account. description: Get an external account. operationId: nsk_v1_organizations2_organizationCode_externalAccounts_externalAccountKey_get parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the account. schema: type: string x-position: 1 - name: externalAccountKey in: path required: true description: The particular external account desired. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationExternalAccountv2' delete: tags: - organizations2 summary: Delete an external account. description: 'GraphQL endpoint: organizationExternalAccountDelete' operationId: nsk_v1_organizations2_organizationCode_externalAccounts_externalAccountKey_delete parameters: - name: organizationCode in: path required: true description: The organization that owns the account to delete. schema: type: string x-position: 1 - name: externalAccountKey in: path required: true description: The particular account to delete. schema: type: string x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/processSchedules: get: tags: - organizations2 summary: Returns a list of Process Schedules for the organization. description: 'GraphQL endpoint: organizationProcessScheduleGetAll' operationId: nsk_v1_organizations2_organizationCode_processSchedules_get parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfOrganizationProcessSchedule' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/processSchedules/{processScheduleId}: post: tags: - organizations2 summary: Adds a process schedule to the organization. description: 'GraphQL endpoint: organizationProcessScheduleAdd' operationId: nsk_v1_organizations2_organizationCode_processSchedules_processScheduleId_post parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 - name: processScheduleId in: path required: true description: The ID of the process schedule. schema: type: integer format: int64 x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - organizations2 summary: Deletes a process schedule from the organization. description: 'GraphQL endpoint: organizationProcessScheduleDelete' operationId: nsk_v1_organizations2_organizationCode_processSchedules_processScheduleId_delete parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 - name: processScheduleId in: path required: true description: The ID of the process schedule. schema: type: integer format: int64 x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/allotments: get: tags: - organizations2 summary: Retrieves all allotments for the specified leg. description: 'GraphQL endpoint: allotments' operationId: nsk_v1_organizations2_allotments_get parameters: - name: legKey in: query description: The leg key. schema: type: string nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAllotmentResponse' examples: Allotment response: description: Returns an allotment response value: allotmentBasisCode: NEGO1 authorizedUnits: 10 allotted: 10 nest: 1 classOfService: NEGO type: 4 rank: 0 seatsSold: 5 latestAdvanceReservation: 0 status: 1 legNestKey: MQ-- legClassKey: Mjk1MTAwNCExIU5FR08- legKey: null marketInformation: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/allotments/{allotmentBasisCode}: get: tags: - organizations2 summary: Retrieves a single allotment for the specified leg using the given allotment basis code. description: 'The allotment basis code should be substituted with allotment class code in Fare Manager Plus environments. GraphQL endpoint: allotment' operationId: nsk_v1_organizations2_allotments_allotmentBasisCode_get parameters: - name: legKey in: query description: The leg key. schema: type: string nullable: true x-position: 1 - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentResponse' examples: Allotment response: description: Returns an allotment response value: allotmentBasisCode: NEGO1 authorizedUnits: 10 allotted: 10 nest: 1 classOfService: NEGO type: 4 rank: 0 seatsSold: 5 latestAdvanceReservation: 0 status: 1 legNestKey: MQ-- legClassKey: Mjk1MTAwNCExIU5FR08- legKey: null marketInformation: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/allotments/{contractCode}/bases: get: tags: - organizations2 summary: Retrieves all allotment bases for the specified contract. description: 'GraphQL endpoint: allotmentBases' operationId: nsk_v1_organizations2_allotments_contractCode_bases_get parameters: - name: contractCode in: path required: true description: The contract code. schema: type: string x-position: 1 - name: PageSize in: query description: "The Page Size, Default 1000\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 2 - name: LastPageKey in: query description: "The LastPageKey, where to start paged query.\n " schema: type: string nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRetrieveAllotmentBasisResponse' examples: Get all Allotment Bases: description: Returns a list of all allotment bases associated with an allotment contract value: lastPageKey: null allotmentBasisResponses: - allotmentBasisCode: AAA contractCode: DEF description: The description status: 1 allotmentType: 1 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: AA ruleNumber: ' The rule number' fareBasisCode: Fare1 - allotmentBasisCode: BBB contractCode: DEF description: The description status: 2 allotmentType: 0 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: NV ruleNumber: ' The rule number' fareBasisCode: Fare1 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - organizations2 summary: Creates the specified allotment basis. description: 'GraphQL endpoint: allotmentBasisAdd' operationId: nsk_v1_organizations2_allotments_contractCode_bases_post parameters: - name: contractCode in: path required: true description: The contract code. schema: type: string x-position: 1 requestBody: x-name: request description: The allotment basis to create. content: application/json: schema: $ref: '#/components/schemas/AllotmentBasisRequest' examples: Allotment Basis Request: description: Creates a new allotment basis value: allotmentBasisCode: ABC description: The description status: 1 allotmentType: 0 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: AA ruleNumber: ' The rule number' fareBasisCode: Fare1 required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/allotments/{contractCode}/bases/{allotmentBasisCode}: put: tags: - organizations2 summary: Updates the specified allotment basis. description: 'GraphQL endpoint: allotmentBasisSet' operationId: nsk_v1_organizations2_allotments_contractCode_bases_allotmentBasisCode_put parameters: - name: contractCode in: path required: true description: The contract code. schema: type: string x-position: 1 - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 2 requestBody: x-name: request description: The allotment basis to update. content: application/json: schema: $ref: '#/components/schemas/AllotmentBasisUpdateRequest' examples: Allotment Basis Request: description: Updates an allotment basis value: description: The description status: 1 allotmentType: 0 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: AA ruleNumber: ' The rule number' fareBasisCode: Fare1 required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/allotments/bases/{allotmentBasisCode}: get: tags: - organizations2 summary: Retrieves the specified allotment basis. description: 'GraphQL endpoint: allotmentBasis' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_get parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code to search for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentBasisResponse' examples: Get Allotment Basis: description: Returns a specific allotment basis value: allotmentMarketFares: - allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.157905Z' discontinueDate: '2026-07-16T05:55:16.1579052Z' allotmentBasisCode: ABC contractCode: DEF description: The description status: 1 allotmentType: 1 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: AA ruleNumber: ' The rule number' fareBasisCode: Fare1 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/allotments/bases/{allotmentBasisCode}/marketFares: get: tags: - organizations2 summary: Gets all market fares for the given allotment basis. description: 'GraphQL endpoint: allotmentBasisMarketFares' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_get parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAllotmentMarketFareResponse' examples: Allotment market fare response: description: Create/update response. value: allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2056803Z' discontinueDate: '2026-07-16T05:55:16.2056804Z' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - organizations2 summary: Creates the specified allotment basis market fare. description: 'GraphQL endpoint: allotmentBasisMarketFareAdd' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_post parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 requestBody: x-name: request description: The allotment market fare request. content: application/json: schema: $ref: '#/components/schemas/AllotmentMarketFareRequest' examples: Allotment market fare request full data: description: Create/update request with full customization. value: stationCode: DEN travelStationCode: SLC directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2099662Z' discontinueDate: '2026-07-16T05:55:16.2099795Z' Allotment market fare request minimum required data: description: Create/update request with minimum required data. Directionality and DiscontinueDate have hard default values. Currency code will default to the default currency code of your environment. value: stationCode: DEN travelStationCode: SLC directionality: null price: 10.0 currencyCode: null releaseDate: '2026-07-09T05:55:16.2099926Z' discontinueDate: null required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentMarketFareResponse' examples: Allotment market fare response: description: Create/update response. value: allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2111129Z' discontinueDate: '2026-07-16T05:55:16.211113Z' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Error response for no request.: description: Only returns raw message in debug mode. value: errors: - id: null code: core:Validation:RequiredArgument message: null type: Error details: null rawMessage: The request is missing a required argument expected in the request. 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 Error response for when the provided stations are the same.: description: '' value: errors: - id: null code: nsk:Allotments:SameStationCodeAndTravelStationCode message: The value for station code 'SLC' and travel station code 'SLC' cannot be the same. type: Validation details: null 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 Error response for when the provided station codes are not in alphabetical order.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidStationOrder message: The station codes provided 'SLC-DEN' need to be in alphabetical order. Please use DEN-SLC. type: Validation details: null 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 Error response for when a provided station code does not exist or is inactive.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidStationCode message: The station code provided 'SLC' is either invalid or not active. type: Validation details: null 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 Error response for when a release or discontinue date is set in the past.: description: '' value: errors: - id: null code: nsk:Allotments:DateSetBeforeToday message: "The provided date '7/2/2026 5:55:16\u202FAM' cannot\ \ be set earlier than today." type: Validation details: null 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 Error response for when the provided discontinue date is before the release date.: description: '' value: errors: - id: null code: nsk:Allotments:DiscontinueDateBeforeReleaseDate message: "The discontinue date '7/8/2026 5:55:16\u202FAM' cannot\ \ be before the release date '7/9/2026 5:55:16\u202FAM'" type: Validation details: null 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 Error response for when the provided price is less than zero.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidPrice message: The price provided '-10.0' is invalid. Price must be a positive decimal value. type: Validation details: null 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 Error response for when the provided allotment basis code could not be found or is invalid.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidAllotmentBasisCode message: The provided allotment basis code 'ABC' does not exist. type: Validation details: null 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 /api/nsk/v1/organizations2/allotments/bases/{allotmentBasisCode}/marketFares/{allotmentMarketFareKey}: get: tags: - organizations2 summary: Gets the specified market fare for the given allotment basis. description: 'GraphQL endpoint: allotmentBasisMarketFare' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_allotmentMarketFareKey_get parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 - name: allotmentMarketFareKey in: path required: true description: The allotment market fare key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentMarketFareResponse' examples: Allotment market fare response: description: Create/update response. value: allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2071958Z' discontinueDate: '2026-07-16T05:55:16.2071959Z' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - organizations2 summary: Updates the specified allotment basis market fare. description: 'GraphQL endpoint: allotmentBasisMarketFareSet' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_allotmentMarketFareKey_put parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 - name: allotmentMarketFareKey in: path required: true description: The target allotment market fare key. schema: type: string x-position: 2 requestBody: x-name: request description: The allotment market fare update request. content: application/json: schema: $ref: '#/components/schemas/AllotmentMarketFareRequest' examples: Allotment market fare request full data: description: Create/update request with full customization. value: stationCode: DEN travelStationCode: SLC directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2138735Z' discontinueDate: '2026-07-16T05:55:16.2138737Z' Allotment market fare request minimum required data: description: Create/update request with minimum required data. Directionality and DiscontinueDate have hard default values. Currency code will default to the default currency code of your environment. value: stationCode: DEN travelStationCode: SLC directionality: null price: 10.0 currencyCode: null releaseDate: '2026-07-09T05:55:16.2138745Z' discontinueDate: null required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentMarketFareResponse' examples: Allotment market fare response: description: Create/update response. value: allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2139324Z' discontinueDate: '2026-07-16T05:55:16.2139324Z' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Error response for no request.: description: Only returns raw message in debug mode. value: errors: - id: null code: core:Validation:RequiredArgument message: null type: Error details: null rawMessage: The request is missing a required argument expected in the request. 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 Error response for when the provided stations are the same.: description: '' value: errors: - id: null code: nsk:Allotments:SameStationCodeAndTravelStationCode message: The value for station code 'SLC' and travel station code 'SLC' cannot be the same. type: Validation details: null 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 Error response for when the provided station codes are not in alphabetical order.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidStationOrder message: The station codes provided 'SLC-DEN' need to be in alphabetical order. Please use DEN-SLC. type: Validation details: null 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 Error response for when a provided station code does not exist or is inactive.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidStationCode message: The station code provided 'SLC' is either invalid or not active. type: Validation details: null 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 Error response for when a release or discontinue date is set in the past.: description: '' value: errors: - id: null code: nsk:Allotments:DateSetBeforeToday message: "The provided date '7/2/2026 5:55:16\u202FAM' cannot\ \ be set earlier than today." type: Validation details: null 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 Error response for when the provided discontinue date is before the release date.: description: '' value: errors: - id: null code: nsk:Allotments:DiscontinueDateBeforeReleaseDate message: "The discontinue date '7/8/2026 5:55:16\u202FAM' cannot\ \ be before the release date '7/9/2026 5:55:16\u202FAM'" type: Validation details: null 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 Error response for when the provided price is less than zero.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidPrice message: The price provided '-10.0' is invalid. Price must be a positive decimal value. type: Validation details: null 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 Error response for when the provided allotment basis code could not be found or is invalid.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidAllotmentBasisCode message: The provided allotment basis code 'ABC' does not exist. type: Validation details: null 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 delete: tags: - organizations2 summary: Deletes the specified allotment basis market fare. description: 'GraphQL endpoint: allotmentBasisMarketFareDelete' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_allotmentMarketFareKey_delete parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 - name: allotmentMarketFareKey in: path required: true description: The target allotment market fare key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Error response for when the provided allotment market fare key could not be deleted.: description: '' value: errors: - id: null code: nsk:Exceptions:DeleteFailed message: Attempted delete of object 'allotmentMarketFareKey' with key 'AllotmentBasisResponse' has failed. Please verify this object exists. type: Validation details: null 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 Error response for when the provided allotment basis code could not be found or is invalid.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidAllotmentBasisCode message: The provided allotment basis code 'ABC' does not exist. type: Validation details: null 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 Error response for when the provided allotment market fare key is invalid.: description: '' value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'allotmentMarketFareKey' with value 'ABC123' is invalid. type: Validation details: null 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 /api/nsk/v1/organizations2/allotments/byAllotmentBasisCode/{allotmentBasisCode}: get: tags: - organizations2 summary: Retrieves all allotments for the specified allotment basis code. description: 'GraphQL endpoint: allotmentsByBasisCode' operationId: nsk_v1_organizations2_allotments_byAllotmentBasisCode_allotmentBasisCode_get parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAllotmentResponse' examples: Allotment response: description: Returns an allotment response value: allotmentBasisCode: NEGO1 authorizedUnits: 10 allotted: 10 nest: 1 classOfService: NEGO type: 4 rank: 0 seatsSold: 5 latestAdvanceReservation: 0 status: 1 legNestKey: MQ-- legClassKey: Mjk1MTAwNCExIU5FR08- legKey: null marketInformation: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/allotments/contracts/{contractCode}: get: tags: - organizations2 summary: Retrieves the specified allotment contract. description: 'GraphQL endpoint: allotmentContract' operationId: nsk_v1_organizations2_allotments_contracts_contractCode_get parameters: - name: contractCode in: path required: true description: The contract code to search for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentContractResponse' examples: Allotment contract response: description: Returns an allotment contract response value: contractCode: ABC description: Travel agency contract status: 1 organizationCode: '123456' discontinueDate: '2026-07-09T05:55:16.17388Z' contractProperties: - contractPropertyCode: ABC value: Test '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/contracts/basis/{allotmentBasisCode}/allotments/legs/{legKey}: post: tags: - organizations2 summary: Creates an allotment for the specified leg. description: 'Due to system limitations, if this endpoint is used the inventory cache will need to be refreshed NegoAlloment and ProrataAllotment are the only allotment class types available. These values align with the ClassType enum. The allotment basis code should be substituted with allotment class code in Fare Manager Plus environments. GraphQL endpoint: allotmentAdd' operationId: nsk_v1_organizations2_contracts_basis_allotmentBasisCode_allotments_legs_legKey_post parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code schema: type: string x-position: 1 - name: legKey in: path required: true description: The leg key schema: type: string x-position: 2 requestBody: x-name: request description: The allotment request. content: application/json: schema: $ref: '#/components/schemas/AllotmentRequest' examples: Allotment Request: description: Creates a new allotment value: authorizedUnits: 10 allotted: 10 nest: 1 classType: 4 rank: 1 latestAdvanceReservation: 0 status: 1 required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentCreatedResponse' examples: Allotment Created Response: description: Creates a new allotment basis value: allotmentBasisCode: ABC legKey: LTg1ODQxODAzMDM2OTI4Mjc3NjEhQUEhMTIzNCEhU0xDIUJPUyExMw-- legNestKey: MTIzNDU2Nzg5ITE- legClassKey: MTIzNDU2Nzg5ITEhQQ-- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - organizations2 summary: Updates an allotment for the specified leg. description: 'Due to system limitations, if this endpoint is used the inventory cache will need to be refreshed. NegoAllotment and ProrataAllotment are the only allotment class types available. These values align with the ClassType enum. The allotment basis code should be substituted with allotment class code in Fare Manager Plus environments. GraphQL endpoint: allotmentSet' operationId: nsk_v1_organizations2_contracts_basis_allotmentBasisCode_allotments_legs_legKey_put parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code schema: type: string x-position: 1 - name: legKey in: path required: true description: The leg key schema: type: string x-position: 2 requestBody: x-name: request description: The allotment request. content: application/json: schema: $ref: '#/components/schemas/AllotmentRequest' examples: Allotment Request: description: Creates a new allotment value: authorizedUnits: 10 allotted: 10 nest: 1 classType: 4 rank: 1 latestAdvanceReservation: 0 status: 1 required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/processSchedule/{processScheduleId}: get: tags: - organizations2 summary: Returns a single Process Schedule object. description: 'GraphQL endpoint: processScheduleGet' operationId: nsk_v1_organizations2_processSchedule_processScheduleId_get parameters: - name: processScheduleId in: path required: true description: The ID of the process schedule to retrieve. schema: type: integer format: int64 x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProcessSchedule' examples: Successfully returned process schedule: description: Example response for successful retrieval of a process schedule. DaysOfWeek represents a single day, which is fixed in the v2 version of this endpoint. None=0, Monday=1, Tuesday=2, through Sunday=7. value: processScheduleId: 123 name: Process Schedule A beginDate: '2026-07-09T05:55:16.2770685+00:00' frequencyType: 0 daysOfWeek: 1 frequency: 2 monthDay: 0 monthWeek: 0 inActive: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProcessSchedule' deprecated: true /api/nsk/v2/organizations2/processSchedule/{processScheduleId}: get: tags: - organizations2 summary: Returns a single Process Schedule object. description: 'GraphQL endpoint: processScheduleGetv2' operationId: nsk_v2_organizations2_processSchedule_processScheduleId_get parameters: - name: processScheduleId in: path required: true description: The ID of the process schedule to retrieve. schema: type: integer format: int64 x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProcessSchedulev2' examples: Successfully returned process schedule: description: Example response for successful retrieval of a process schedule. DaysOfWeek is a list in which None=0, Monday=1, Tuesday=2, through Sunday=7. value: processScheduleId: 123 name: Process Schedule A beginDate: '2026-07-09T05:55:16.3018561+00:00' frequencyType: 0 daysOfWeek: - 1 - 3 - 5 frequency: 2 monthDay: 0 monthWeek: 0 inActive: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProcessSchedulev2' /api/nsk/v1/organizations2/processSchedules: get: tags: - organizations2 summary: Returns a list of active process schedules. description: 'GraphQL endpoint: processScheduleGetAll' operationId: nsk_v1_organizations2_processSchedules_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfProcessSchedule' examples: Successfully returned list of all process schedules: description: Example response for successful retrieval of all process schedules. DaysOfWeek represents a single day, which is fixed in the v2 version of this endpoint. None=0, Monday=1, Tuesday=2, through Sunday=7. value: - processScheduleId: 123 name: Process Schedule - Runs every other Monday beginDate: '2026-07-09T05:55:16.2730672+00:00' frequencyType: 0 daysOfWeek: 1 frequency: 2 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 124 name: Process Schedule - Runs every third Tuesday beginDate: '2026-07-09T05:55:16.2731542+00:00' frequencyType: 1 daysOfWeek: 2 frequency: 3 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 125 name: Process Schedule - Runs the second Saturday of each month beginDate: '2026-07-09T05:55:16.2731546+00:00' frequencyType: 2 daysOfWeek: 6 frequency: 1 monthDay: 0 monthWeek: 2 inActive: false - processScheduleId: 126 name: Process Schedule - Runs every day beginDate: '2026-07-09T05:55:16.2731548+00:00' frequencyType: 0 daysOfWeek: 0 frequency: 1 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 127 name: Process Schedule - Runs every third day beginDate: '2026-07-09T05:55:16.273155+00:00' frequencyType: 0 daysOfWeek: 0 frequency: 3 monthDay: 0 monthWeek: 0 inActive: false deprecated: true /api/nsk/v2/organizations2/processSchedules: get: tags: - organizations2 summary: Returns a list of active process schedules. description: 'GraphQL endpoint: processScheduleGetAllv2' operationId: nsk_v2_organizations2_processSchedules_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfProcessSchedulev2' examples: Successfully returned list of all process schedules: description: Example response for successful retrieval of all process schedules. DaysOfWeek is a list in which None=0, Monday=1, Tuesday=2, through Sunday=7. value: - processScheduleId: 123 name: Process Schedule - Runs every Mon Wed Fri beginDate: '2026-07-09T05:55:16.2984575+00:00' frequencyType: 0 daysOfWeek: - 1 - 3 - 5 frequency: 1 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 124 name: Process Schedule - Runs every third Tuesday beginDate: '2026-07-09T05:55:16.2985787+00:00' frequencyType: 1 daysOfWeek: - 2 frequency: 3 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 125 name: Process Schedule - Runs the second Saturday of each month beginDate: '2026-07-09T05:55:16.2985793+00:00' frequencyType: 2 daysOfWeek: - 6 frequency: 1 monthDay: 0 monthWeek: 2 inActive: false - processScheduleId: 126 name: Process Schedule - Runs every day beginDate: '2026-07-09T05:55:16.2985818+00:00' frequencyType: 0 daysOfWeek: - 0 frequency: 1 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 127 name: Process Schedule - Runs every other day beginDate: '2026-07-09T05:55:16.2985821+00:00' frequencyType: 0 daysOfWeek: - 0 frequency: 2 monthDay: 0 monthWeek: 0 inActive: false /api/nsk/v1/organizations2/register: post: tags: - organizations2 summary: Requests to register a new organization. description: 'Note: This is only a request. An agent will need to approve the action. GraphQL endpoint: organization2RegisterAdd' operationId: nsk_v1_organizations2_register_post requestBody: x-name: registerRequest description: The request for registering a new organization. content: application/json: schema: $ref: '#/components/schemas/OrganizationRegisterRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/payments: get: tags: - payments summary: Gets the payment data based on the specified bank identification number and date range. description: 'GraphQL endpoint: paymentsSearchByBin' operationId: nsk_v1_payments_get parameters: - name: BankIdentificationNumber in: query description: "The bank identification number to search for. This is the first\ \ 6 digits of the card number.\n " schema: type: integer format: int32 maximum: 999999.0 minimum: 100000.0 nullable: true x-position: 1 - name: StartDate in: query description: "The start date to search for. This refers to the date the payment\ \ was made.\n " schema: type: string format: date-time nullable: true x-position: 2 - name: EndDate in: query description: "The end date.\n " schema: type: string format: date-time nullable: true x-position: 3 - name: PageSize in: query description: "The number of payment records per request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: LastPageKey in: query description: "The key for the last payment record returned from paged response.\n\ \ " schema: type: string nullable: true x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedFindPaymentsByBinResponse' examples: With matching payment data from card payments: description: Example response for successful retrieval of card payment data by BIN. value: data: lastPageKey: OA-- totalCount: 10 paymentRecords: mjc2NDIzIVlEVEQ3RQ--: - accountNumber: XXXXXXXXXXXX1111 paymentDate: '2026-07-09T05:55:13.3927326Z' passengerName: first: Jane middle: null last: Doe title: null suffix: null departureDate: '2026-07-09T05:55:13.3927626+00:00' status: 3 recordLocator: XYZ456 origin: SLC destination: BOS - accountNumber: XXXXXXXXXXXX1111 paymentDate: '2026-07-09T05:55:13.3928148Z' passengerName: first: Jane middle: null last: Doe title: null suffix: null departureDate: '2026-07-10T05:55:13.392815+00:00' status: 3 recordLocator: XYZ456 origin: BOS destination: SLC mjc2NDY1IVRFRTlURQ--: - accountNumber: XXXXXXXXXXXX1111 paymentDate: '2026-07-09T05:55:13.3928266Z' passengerName: first: John middle: null last: Doe title: null suffix: null departureDate: '2026-07-09T05:55:13.3928268+00:00' status: 4 recordLocator: ABC123 origin: SLC destination: BOS - accountNumber: XXXXXXXXXXXX1111 paymentDate: '2026-07-09T06:05:13.392827Z' passengerName: first: John middle: null last: Doe title: null suffix: null departureDate: '2026-07-09T05:55:13.3928274+00:00' status: 3 recordLocator: ABC123 origin: SLC destination: BOS No matching payment data: description: Example response when no payment data matches the query. value: data: lastPageKey: MTA- totalCount: 0 paymentRecords: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid BIN value: description: Example error if the BIN value is not specified or invalid value: errors: - code: FindPaymentsByBinRequest.BankIdentificationNumber:RequiredAttribute message: The FindPaymentsByBinRequest field is required. type: Validation number: null details: member: BankIdentificationNumber model: FindPaymentsByBinRequest validation: RangeAttribute Out of range BIN value: description: Example error if the BIN value is out of range. value: errors: - code: FindPaymentsByBinRequest.BankIdentificationNumber:RangeAttribute message: The field FindPaymentsByBinRequest must be between 100000 and 999999. type: Validation number: null details: member: BankIdentificationNumber model: FindPaymentsByBinRequest validation: RangeAttribute Start date not specified: description: Example error if the start date is not specified. value: errors: - code: nsk:Validation:StartDateRequired message: The start date is required for the request. type: Validation number: null details: member: StartDate model: FindPaymentsByBinRequest validation: RequiredAttribute End date before start date: description: Example error if the end date is before the start date. value: errors: - code: nsk:Validation:EndDateBeforeBeginDate message: The requested end date of 1/1/2024 occurs before the requested begin date of 1/30/2024. type: Validation number: null details: null Agent not allowed: description: Example error if the agent is not authorized to search payments by bank identification number. value: errors: - code: nsk:Payment:SearchPaymentsByBinNotAllowed message: Searching payment records by BIN is not allowed based on the current user's permissions. type: Validation number: null details: null Do Not Persist External Payment Details Enabled: description: Example error if The Do not Persist External Payment Details premium feature is enabled. value: errors: - code: nsk:SystemSettings:DoNotPersistExternalPaymentDetailsEnabled message: The Do not Persist External Payment Details premium feature is enabled. type: Validation number: null details: null /api/nsk/v1/persons: post: tags: - persons summary: Creates a new person record (used by agents). description: 'This endpoint requires agent permissions. GraphQL endpoint: personAdd' operationId: nsk_v1_persons_post requestBody: x-name: request description: The person create request. content: application/json: schema: $ref: '#/components/schemas/PersonCreateRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/persons: get: tags: - persons summary: Search person records. description: 'GraphQL endpoint: personSearchv2' operationId: nsk_v2_persons_get parameters: - name: LastIndex in: query description: "The index of the last paged item. This can be found on the\n\ response from the previous set of paged results.\n " schema: type: integer format: int32 nullable: true x-position: 1 - name: Username in: query description: "The person user name to search by.\n " schema: type: string nullable: true x-position: 2 - name: FirstName in: query description: "The person's first name to search by.\n " schema: type: string nullable: true x-position: 3 - name: LastName in: query description: "The person's last name to search by.\n " schema: type: string nullable: true x-position: 4 - name: FirstNameMatching in: query description: "The matching criteria for the person's first name.\n \ \ \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains,\ \ 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 5 - name: CustomerNumber in: query description: "The person's customer number.\n " schema: type: string nullable: true x-position: 6 - name: PhoneNumber in: query description: "The phone number to search by.\n " schema: type: string nullable: true x-position: 7 - name: EmailAddress in: query description: "The email address to search by.\n " schema: type: string nullable: true x-position: 8 - name: ProgramNumber in: query description: "The program number to search by.\n " schema: type: string nullable: true x-position: 9 - name: ProgramCode in: query description: "The program code to search by.\n " schema: type: string nullable: true x-position: 10 - name: Type in: query description: "The person type to search by.\n \nEnumeration values:\ \ 0 = None, 1 = Customer, 2 = Agent" schema: nullable: true $ref: '#/components/schemas/PersonType' x-position: 11 - name: NationalIdNumber in: query description: "The national ID number to search by.\n " schema: type: string nullable: true x-position: 12 - name: NationalIdNumberMatching in: query description: "The matching criteria for the national ID number.\n \ \ \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains,\ \ 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 13 - name: ReturnCount in: query description: "The number of results to return.\n " schema: type: integer nullable: true x-position: 14 - name: ActiveOnly in: query description: "Include active person records only.\n " schema: type: boolean x-position: 15 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonRecordsResponse' /api/nsk/v1/persons/{personKey}: get: tags: - persons summary: Retrieves a specific person by key. description: 'GraphQL endpoint: person' operationId: nsk_v1_persons_personKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPerson' put: tags: - persons summary: Updates the person record basic information. description: 'GraphQL endpoint: personSet' operationId: nsk_v1_persons_personKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The person edit request. content: application/json: schema: $ref: '#/components/schemas/PersonEditRequest' examples: Person Edit Request: description: Example request for updating person's basic information. value: name: first: John middle: Cee last: Doe title: Mr. suffix: null type: 1 status: 0 details: gender: 1 dateOfBirth: '2006-07-09T05:55:16.0597472+00:00' nationality: US residentCountry: US passengerType: ADT preferredCultureCode: en-US preferredCurrencyCode: USD nationalIdNumber: null declaredGender: null notificationPreference: 0 required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Preferred Culture Code: description: The provided culture code in the request is an invalid culture identifier. value: errors: - id: null code: nsk:Person:InvalidPreferredCulture message: nsk:Person:InvalidPreferredCulture type: Validation details: null rawMessage: The preferred culture code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Preferred Currency Code: description: The provided currency code in the request is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidPreferredCurrency message: nsk:Person:InvalidPreferredCurrency type: Validation details: null rawMessage: The preferred currency code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid First Name: description: The provided first name in the request starts with a numerical or special character. value: errors: - id: null code: nsk:Validation:InvalidFirstNameCharacters message: "A first name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." type: Validation details: null rawMessage: "A first name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." 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. With Invalid Middle Name: description: The provided middle name in the request starts with a special character. value: errors: - id: null code: nsk:Validation:InvalidMiddleNameCharacters message: "A middle name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>." type: Validation details: null rawMessage: "A middle name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>." 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. With Invalid Last Name: description: The provided last name in the request starts with a numerical or special character. value: errors: - id: null code: nsk:Validation:InvalidLastNameCharacters message: "A last name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." type: Validation details: null rawMessage: "A last name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." 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. Update Status Not Allowed: description: The logged-in user is not allowed to update the person's status. value: errors: - id: null code: nsk:Person:StatusUpdateNotAllowed message: nsk:Person:StatusUpdateNotAllowed type: Validation details: null rawMessage: The logged-in user is not allowed to update their status. 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. Update Type Not Allowed: description: The logged-in user is not allowed to update the person's type. value: errors: - id: null code: nsk:Person:TypeUpdateNotAllowed message: nsk:Person:TypeUpdateNotAllowed type: Validation details: null rawMessage: The logged-in user is not allowed to update their type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches the person record basic information. description: 'Only need to send in the data that is being requested to be updated. GraphQL endpoint: personModify' operationId: nsk_v1_persons_personKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The person patch request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonEditRequest' examples: Person Edit Request: description: Example request for updating person's basic information. value: name: first: John middle: Cee last: Doe title: Mr. suffix: null type: 1 status: 0 details: gender: 1 dateOfBirth: '2006-07-09T05:55:16.06105+00:00' nationality: US residentCountry: US passengerType: ADT preferredCultureCode: en-US preferredCurrencyCode: USD nationalIdNumber: null declaredGender: null notificationPreference: 0 required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Preferred Culture Code: description: The provided culture code in the request is an invalid culture identifier. value: errors: - id: null code: nsk:Person:InvalidPreferredCulture message: nsk:Person:InvalidPreferredCulture type: Validation details: null rawMessage: The preferred culture code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Preferred Currency Code: description: The provided currency code in the request is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidPreferredCurrency message: nsk:Person:InvalidPreferredCurrency type: Validation details: null rawMessage: The preferred currency code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid First Name: description: The provided first name in the request starts with a numerical or special character. value: errors: - id: null code: nsk:Validation:InvalidFirstNameCharacters message: "A first name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." type: Validation details: null rawMessage: "A first name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." 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. With Invalid Middle Name: description: The provided middle name in the request starts with a special character. value: errors: - id: null code: nsk:Validation:InvalidMiddleNameCharacters message: "A middle name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>." type: Validation details: null rawMessage: "A middle name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>." 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. With Invalid Last Name: description: The provided last name in the request starts with a numerical or special character. value: errors: - id: null code: nsk:Validation:InvalidLastNameCharacters message: "A last name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." type: Validation details: null rawMessage: "A last name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." 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. Update Status Not Allowed: description: The logged-in user is not allowed to update the person's status. value: errors: - id: null code: nsk:Person:StatusUpdateNotAllowed message: nsk:Person:StatusUpdateNotAllowed type: Validation details: null rawMessage: The logged-in user is not allowed to update their status. 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. Update Type Not Allowed: description: The logged-in user is not allowed to update the person's type. value: errors: - id: null code: nsk:Person:TypeUpdateNotAllowed message: nsk:Person:TypeUpdateNotAllowed type: Validation details: null rawMessage: The logged-in user is not allowed to update their type. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a person by setting the record to terminated. description: 'This endpoint requires agent permissions. GraphQL endpoint: personDelete' operationId: nsk_v1_persons_personKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/account: get: tags: - persons summary: Retrieves the person account and credits based on the person key. description: 'If the currency code is not provided it will default to the currency code associated to the account. GraphQL endpoint: personsAccount' operationId: nsk_v1_persons_personKey_account_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: currencyCode in: query description: The currency code. This is optional. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAccount' post: tags: - persons summary: 'Creates the person account based on the person key and data in the request.' description: 'GraphQL endpoint: personsAccountAdd' operationId: nsk_v1_persons_personKey_account_post parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 requestBody: x-name: request description: The create account request. content: application/json: schema: $ref: '#/components/schemas/CreateAccountRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/account/collection: post: tags: - persons summary: Creates an account collection based on the person key and data in the request. description: 'This endpoint will create a new account collection and a transaction if no account transaction exists or no matching collection is found. An account collection is unique based on the transaction code and the expiration date. If a matching account collection is found, a transaction for that collection is generated and the account collection will be updated. See /api/nsk/v1/resources/accountTransactionCodes for a list of available account transaction codes. GraphQL endpoint: personsAccountCollectionsAdd' operationId: nsk_v1_persons_personKey_account_collection_post parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 requestBody: x-name: request description: The create account collection request. content: application/json: schema: $ref: '#/components/schemas/AccountCollectionRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/account/collection/{accountCollectionKey}/transactions: get: tags: - persons summary: 'Retrieves the person account collection transactions based on the person key, the account collection key, and data in the request.' description: 'GraphQL endpoint: personsAccountTransactions' operationId: nsk_v1_persons_personKey_account_collection_accountCollectionKey_transactions_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 2 - name: StartTime in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: EndTime in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 4 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 5 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 6 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n \ \ " schema: type: integer format: int64 nullable: true x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTransaction' examples: Retrieve Transactions Response: description: Example response for retrieving transactions. value: data: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3678462Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. 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 deprecated: true post: tags: - persons summary: 'Creates an account collection transaction based on the person key, the account collection key, and data in the request.' description: 'This endpoint will add a transaction to an existing account collection. If there are no account collections, or the account collection key does not match an existing collection, the request will fail. To add a new account collection, see /api/nsk/v1/persons/{personKey}/account/collection. GraphQL endpoint: personsAccountTransactionsAdd' operationId: nsk_v1_persons_personKey_account_collection_accountCollectionKey_transactions_post parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 2 requestBody: x-name: request description: The create transaction request. content: application/json: schema: $ref: '#/components/schemas/TransactionRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/persons/{personKey}/account/collection/{accountCollectionKey}/transactions: get: tags: - persons summary: Retrieves the person account collection transactions based on the person key, the account collection key, and data in the request. description: 'GraphQL endpoint: personsAccountTransactionsv2' operationId: nsk_v2_persons_personKey_account_collection_accountCollectionKey_transactions_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: accountCollectionKey in: path required: true description: The account collection key. schema: type: string x-position: 2 - name: StartDate in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: EndDate in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 4 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 5 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 6 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: string nullable: true x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedTransactionResponse' examples: Retrieve Transactions Successful: description: Example response for a successful retrieval of transactions. value: data: totalCount: 11085 lastPageKey: MTAw transactions: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3919295Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/persons/{personKey}/account/status: put: tags: - persons summary: Updates the person account status. description: 'GraphQL endpoint: personsAccountStatusSet' operationId: nsk_v1_persons_personKey_account_status_put parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: status in: query description: "The new account status. \nEnumeration values: 0 = Open, 1 =\ \ Closed, 2 = AgencyInactive, 3 = Unknown" schema: $ref: '#/components/schemas/AccountStatus' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/account/transactions: get: tags: - persons summary: Retrieves all transactions for every collection. description: 'GraphQL endpoint: personsAccountAllTransactions' operationId: nsk_v1_persons_personKey_account_transactions_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: StartTime in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 2 - name: EndTime in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n \ \ " schema: type: integer format: int64 nullable: true x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTransaction' examples: Retrieve Transactions Response: description: Example response for retrieving transactions. value: data: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3701304Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. 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 deprecated: true /api/nsk/v2/persons/{personKey}/account/transactions: get: tags: - persons summary: Retrieves all persons account transactions. description: 'GraphQL endpoint: personsAccountAllTransactionsv2' operationId: nsk_v2_persons_personKey_account_transactions_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: StartDate in: query description: "The starting date and time of the date range to search in.\n\ \ " schema: type: string format: date-time nullable: true x-position: 2 - name: EndDate in: query description: "The end date and time of the date range to search in.\n \ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: SortByNewest in: query description: "Optional filter to sort results by newest.\n " schema: type: boolean x-position: 4 - name: PageSize in: query description: "Used to specify the number of records to return.\n \ \ " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: string nullable: true x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedTransactionResponse' examples: Retrieve Transactions Successful: description: Example response for a successful retrieval of transactions. value: data: totalCount: 11085 lastPageKey: MTAw transactions: - accountTransactionCode: null recordLocator: null accountReference: null transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ amount: -2.42 createdDate: '2026-07-09T05:55:16.3906143Z' currencyCode: USD foreignAmount: -15.0 note: 'Funds Used: PNR123' foreignCurrencyCode: CNY type: 0 paymentId: 365423 accountCollectionKey: MSex '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Empty Start Date: description: Example response when start date field is empty. value: errors: - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b code: TransactionSearchRequestv2.StartDate:RequiredAttribute message: TransactionSearchRequestv2.StartDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: TransactionSearchRequestv2 member: StartDate rawMessage: The TransactionSearchRequestv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End Date Before Start Date: description: Example response when end date is before start date. value: errors: - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87 code: nsk:Validation:EndDateBeforeStartDate message: nsk:Validation:EndDateBeforeStartDate type: Validation details: null rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/persons/{personKey}/addresses: get: tags: - persons summary: Gets the collection of addresses for a specific person. description: Gets the collection of addresses for a specific person. operationId: nsk_v1_persons_personKey_addresses_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonAddress' post: tags: - persons summary: Creates a new address for a specific person. description: 'GraphQL endpoint: personAddressAdd' operationId: nsk_v1_persons_personKey_addresses_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new address. content: application/json: schema: $ref: '#/components/schemas/PersonAddressCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/addresses/{personAddressKey}: get: tags: - persons summary: Gets a specific address for a specific person. description: 'GraphQL endpoint: personAddress' operationId: nsk_v1_persons_personKey_addresses_personAddressKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAddressKey in: path required: true description: The unique address key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonAddress' put: tags: - persons summary: Updates a specific address for a specific person. description: 'GraphQL endpoint: personAddressSet' operationId: nsk_v1_persons_personKey_addresses_personAddressKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAddressKey in: path required: true description: The unique person address key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified address. content: application/json: schema: $ref: '#/components/schemas/PersonAddressEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches a specific address for a specific person. description: 'GraphQL endpoint: personAddressModify' operationId: nsk_v1_persons_personKey_addresses_personAddressKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAddressKey in: path required: true description: The unique person address key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched address. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonAddressEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a specific address for a specific person. description: 'GraphQL endpoint: personAddressDelete' operationId: nsk_v1_persons_personKey_addresses_personAddressKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAddressKey in: path required: true description: The unique person address key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/affiliations: get: tags: - persons summary: Gets all affiliations for a specific person. description: 'GraphQL endpoint: personAffiliations' operationId: nsk_v1_persons_personKey_affiliations_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonAffiliation' post: tags: - persons summary: Creates a new affiliation for a specific person. description: 'GraphQL endpoint: personAffiliationAdd' operationId: nsk_v1_persons_personKey_affiliations_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new affiliation. content: application/json: schema: $ref: '#/components/schemas/PersonAffiliationRequest' examples: Person Affiliation Request: description: Example request for creating or updating a person's affiliation. value: name: John Doe required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/affiliations/{personAffiliationKey}: get: tags: - persons summary: Gets a specific affiliation for a specific person. description: 'GraphQL endpoint: personAffiliation' operationId: nsk_v1_persons_personKey_affiliations_personAffiliationKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAffiliationKey in: path required: true description: The unique person affiliation key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonAffiliation' put: tags: - persons summary: Updates a specific affiliation for a specific person. description: 'GraphQL endpoint: personAffiliationSet' operationId: nsk_v1_persons_personKey_affiliations_personAffiliationKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAffiliationKey in: path required: true description: The unique person affiliation key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified affiliation. content: application/json: schema: $ref: '#/components/schemas/PersonAffiliationRequest' examples: Person Affiliation Request: description: Example request for creating or updating a person's affiliation. value: name: John Doe required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Affiliation Key: description: The person affiliation key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonAffiliation' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a specific affiliation for a specific person. description: 'GraphQL endpoint: personAffiliationDelete' operationId: nsk_v1_persons_personKey_affiliations_personAffiliationKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAffiliationKey in: path required: true description: The unique person affiliation key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/aliases: get: tags: - persons summary: Gets the collection of aliases for a specific person. description: Gets the collection of aliases for a specific person. operationId: nsk_v1_persons_personKey_aliases_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonAlias' post: tags: - persons summary: Creates a new alias for a specific person. description: 'GraphQL endpoint: personAliasAdd' operationId: nsk_v1_persons_personKey_aliases_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new alias. content: application/json: schema: $ref: '#/components/schemas/PersonAliasRequest' examples: Person Alias Request: description: Example request for creating or updating a person's alias. value: type: 0 first: John middle: Cee last: Doe title: Mr. suffix: null required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/aliases/{personAliasKey}: get: tags: - persons summary: Gets a specific alias for a specific person. description: 'GraphQL endpoint: personAlias' operationId: nsk_v1_persons_personKey_aliases_personAliasKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAliasKey in: path required: true description: The unique person alias key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonAlias' put: tags: - persons summary: Updates a specific alias for a specific person. description: 'GraphQL endpoint: personAliasSet' operationId: nsk_v1_persons_personKey_aliases_personAliasKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAliasKey in: path required: true description: The unique person alias key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified alias. content: application/json: schema: $ref: '#/components/schemas/PersonAliasRequest' examples: Person Alias Request: description: Example request for creating or updating a person's alias. value: type: 0 first: John middle: Cee last: Doe title: Mr. suffix: null required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Alias Key: description: The person alias key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonAlias' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches a specific alias for a specific person. description: 'GraphQL endpoint: personAliasModify' operationId: nsk_v1_persons_personKey_aliases_personAliasKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAliasKey in: path required: true description: The unique person alias key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched alias. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonAliasRequest' examples: Person Alias Request: description: Example request for creating or updating a person's alias. value: type: 0 first: John middle: Cee last: Doe title: Mr. suffix: null required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Alias Key: description: The person alias key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personAliasKey' with value 'MTW' is invalid. type: Validation details: personAliasKey: MTW rawMessage: The identifier 'personAliasKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a specific alias for a specific person. description: 'GraphQL endpoint: personAliasDelete' operationId: nsk_v1_persons_personKey_aliases_personAliasKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personAliasKey in: path required: true description: The unique person alias key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/comments: get: tags: - persons summary: Gets the collection of comments for a specific person. description: 'GraphQL endpoint: personComments' operationId: nsk_v1_persons_personKey_comments_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonComment' post: tags: - persons summary: Creates a new comment for a specific person. description: 'GraphQL endpoint: personCommentAdd' operationId: nsk_v1_persons_personKey_comments_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new comment. content: application/json: schema: $ref: '#/components/schemas/PersonCommentRequest' examples: Person Comment Request: description: Example request for creating or updating a person's comment. value: text: Comment type: 0 required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/comments/{personCommentKey}: get: tags: - persons summary: Gets a specific comment for a specific person. description: 'GraphQL endpoint: personComment' operationId: nsk_v1_persons_personKey_comments_personCommentKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personCommentKey in: path required: true description: The unique comment key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonComment' put: tags: - persons summary: Updates a specific comment for a specific person. description: 'GraphQL endpoint: personCommentSet' operationId: nsk_v1_persons_personKey_comments_personCommentKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personCommentKey in: path required: true description: The unique person comment key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified comment. content: application/json: schema: $ref: '#/components/schemas/PersonCommentRequest' examples: Person Comment Request: description: Example request for creating or updating a person's comment. value: text: Comment type: 0 required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Comment Key: description: The person comment key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonComment' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches a specific comment for a specific person. description: 'GraphQL endpoint: personCommentModify' operationId: nsk_v1_persons_personKey_comments_personCommentKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personCommentKey in: path required: true description: The unique person comment key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched comment. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonCommentRequest' examples: Person Comment Request: description: Example request for creating or updating a person's comment. value: text: Comment type: 0 required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Comment Key: description: The person comment key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonComment' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a specific comment for a specific person. description: 'GraphQL endpoint: personCommentDelete' operationId: nsk_v1_persons_personKey_comments_personCommentKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personCommentKey in: path required: true description: The unique person comment key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/emails: get: tags: - persons summary: Gets the collection of email addresses for a specific person. description: Gets the collection of email addresses for a specific person. operationId: nsk_v1_persons_personKey_emails_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonEmail' post: tags: - persons summary: Creates a new email address for a specific person. description: 'The "type" property for the request is a single character. See the "/resources/EmailTypes" endpoint for valid email type codes. GraphQL endpoint: personEmailAdd' operationId: nsk_v1_persons_personKey_emails_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new email address. content: application/json: schema: $ref: '#/components/schemas/EmailCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/emails/{personEmailAddressKey}: get: tags: - persons summary: Gets a specific email address for a specific person. description: 'GraphQL endpoint: personEmail' operationId: nsk_v1_persons_personKey_emails_personEmailAddressKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personEmailAddressKey in: path required: true description: The unique email address key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonEmail' put: tags: - persons summary: Updates a specific email address for a specific person. description: 'GraphQL endpoint: personEmailSet' operationId: nsk_v1_persons_personKey_emails_personEmailAddressKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personEmailAddressKey in: path required: true description: The unique person email address key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified email address. content: application/json: schema: $ref: '#/components/schemas/EmailEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches a specific email address for a specific person. description: 'GraphQL endpoint: personEmailModify' operationId: nsk_v1_persons_personKey_emails_personEmailAddressKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personEmailAddressKey in: path required: true description: The unique person email address key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched email address. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfEmailEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a specific email address for a specific person. description: 'GraphQL endpoint: personEmailDelete' operationId: nsk_v1_persons_personKey_emails_personEmailAddressKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personEmailAddressKey in: path required: true description: The unique person email address key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/information: get: tags: - persons summary: Gets all information for a specific person. description: 'GraphQL endpoint: personInformations' operationId: nsk_v1_persons_personKey_information_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonInformation' examples: Retrieve Person Information: description: Successful retrieval of person information value: personInformationKey: NTcxMzkhQQ- size: 246 personInformationTypeCode: A data:
John Doe Harrison Street Los Angeles US post: tags: - persons summary: Creates new information for a specific person. description: 'GraphQL endpoint: personInformationAdd' operationId: nsk_v1_persons_personKey_information_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new information. content: application/json: schema: $ref: '#/components/schemas/PersonInformationCreateRequest' examples: Create Person Information: description: Example request for creating person information. For a list of valid person information type code, kindly refer to the GET /api/nsk/v1/resources/PersonInformationTypes endpoint. value: personInformationTypeCode: A data:
John Doe Harrison Street Los Angeles US required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid nor does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v1/persons/{personKey}/information/{personInformationKey}: get: tags: - persons summary: Gets specific information for a specific person. description: 'GraphQL endpoint: personInformation' operationId: nsk_v1_persons_personKey_information_personInformationKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personInformationKey in: path required: true description: The unique person information key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonInformation' examples: Retrieve Person Information: description: Successful retrieval of person information value: personInformationKey: NTcxMzkhQQ- size: 246 personInformationTypeCode: A data:
John Doe Harrison Street Los Angeles US put: tags: - persons summary: Updates specific information for a specific person. description: 'GraphQL endpoint: personInformationSet' operationId: nsk_v1_persons_personKey_information_personInformationKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personInformationKey in: path required: true description: The unique person information key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified information. content: application/json: schema: $ref: '#/components/schemas/PersonInformationEditRequest' examples: Modify Person Information: description: Example request for modifying person information value: data:
John Doe Harrison Street Los Angeles US required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid nor does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid or Null Person Information Key: description: The person information key is empty, not valid or does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'personInformationKey' with value 'MTW' is invalid. type: Validation details: personInformationKey: MTW rawMessage: The identifier 'personInformationKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches specific information for a specific person. description: 'GraphQL endpoint: personInformationModify' operationId: nsk_v1_persons_personKey_information_personInformationKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personInformationKey in: path required: true description: The unique person information key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched information. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonInformationEditRequest' examples: Modify Person Information: description: Example request for modifying person information value: data:
John Doe Harrison Street Los Angeles US required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid nor does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid or Null Person Information Key: description: The person information key is empty, not valid or does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonInformation' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes specific information for a specific person. description: 'GraphQL endpoint: personInformationDelete' operationId: nsk_v1_persons_personKey_information_personInformationKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personInformationKey in: path required: true description: The unique person information key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/merge: put: tags: - persons summary: Updates a person by merging the PNRs associated, account information and optionally the customer programs. description: '- If new name is not given the name of the person to be updated will be retained. - This endpoint requires agent permissions. GraphQL endpoint: personMerge' operationId: nsk_v1_persons_personKey_merge_put parameters: - name: personKey in: path required: true description: The person to be updated and merged on to. schema: type: string x-position: 1 requestBody: x-name: requestBase description: The person merge request. content: application/json: schema: $ref: '#/components/schemas/PersonMergeRequestBase' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/phoneNumbers: get: tags: - persons summary: Gets the collection of phone numbers for a specific person. description: Gets the collection of phone numbers for a specific person. operationId: nsk_v1_persons_personKey_phoneNumbers_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonPhoneNumber' post: tags: - persons summary: Creates a new phone number for a specific person. description: 'GraphQL endpoint: personPhoneNumberAdd' operationId: nsk_v1_persons_personKey_phoneNumbers_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new phone number. content: application/json: schema: $ref: '#/components/schemas/PersonPhoneNumberRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/phoneNumbers/{personPhoneNumberKey}: get: tags: - persons summary: Gets a specific phone number for a specific person. description: 'GraphQL endpoint: personPhoneNumber' operationId: nsk_v1_persons_personKey_phoneNumbers_personPhoneNumberKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personPhoneNumberKey in: path required: true description: The unique phone number key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonPhoneNumber' put: tags: - persons summary: Updates a specific phone number for a specific person. description: 'GraphQL endpoint: personPhoneNumberSet' operationId: nsk_v1_persons_personKey_phoneNumbers_personPhoneNumberKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personPhoneNumberKey in: path required: true description: The unique person phone number key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified phone number. content: application/json: schema: $ref: '#/components/schemas/PersonPhoneNumberRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches a specific phone number for a specific person. description: 'GraphQL endpoint: personPhoneNumberModify' operationId: nsk_v1_persons_personKey_phoneNumbers_personPhoneNumberKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personPhoneNumberKey in: path required: true description: The unique person phone number key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched phone number. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonPhoneNumberRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a specific phone number for a specific person. description: 'GraphQL endpoint: personPhoneNumberDelete' operationId: nsk_v1_persons_personKey_phoneNumbers_personPhoneNumberKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personPhoneNumberKey in: path required: true description: The unique person phone number key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/preferences: get: tags: - persons summary: Gets all preferences for a specific person. description: Gets all preferences for a specific person. operationId: nsk_v1_persons_personKey_preferences_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonPreference' post: tags: - persons summary: Creates a new preference for a specific person. description: 'GraphQL endpoint: personPreferenceAdd' operationId: nsk_v1_persons_personKey_preferences_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new preference. content: application/json: schema: $ref: '#/components/schemas/PersonPreferenceCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/preferences/{personPreferenceKey}: get: tags: - persons summary: Gets a specific preference for a specific person. description: 'GraphQL endpoint: personPreference' operationId: nsk_v1_persons_personKey_preferences_personPreferenceKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personPreferenceKey in: path required: true description: The unique person preference key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonPreference' put: tags: - persons summary: Updates a specific preference for a specific person. description: 'GraphQL endpoint: personPreferenceSet' operationId: nsk_v1_persons_personKey_preferences_personPreferenceKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personPreferenceKey in: path required: true description: The unique person preference key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified preference. content: application/json: schema: $ref: '#/components/schemas/PersonPreferenceEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches a specific preference for a specific person. description: 'GraphQL endpoint: personPreferenceModify' operationId: nsk_v1_persons_personKey_preferences_personPreferenceKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personPreferenceKey in: path required: true description: The unique person preference key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched preference. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonPreferenceEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a specific preference for a specific person. description: 'GraphQL endpoint: personPreferenceDelete' operationId: nsk_v1_persons_personKey_preferences_personPreferenceKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personPreferenceKey in: path required: true description: The unique person preference key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/programs: get: tags: - persons summary: Gets the collection of programs for a specific person. description: 'GraphQL endpoint: personPrograms' operationId: nsk_v1_persons_personKey_programs_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonCustomerProgram' post: tags: - persons summary: Creates a new program for a specific person. description: 'GraphQL endpoint: personProgramAdd' operationId: nsk_v1_persons_personKey_programs_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new program. content: application/json: schema: $ref: '#/components/schemas/PersonCustomerProgramCreateRequest' examples: Person Customer Program Create Request: description: Example request for creating a person's customer program. value: programCode: LOY programNumber: '12345' effectiveDate: '2026-07-10T00:00:00+00:00' expirationDate: '2027-07-09T00:00:00+00:00' default: true programLevelCode: A required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. With Invalid Program Code: description: The program code is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidProgramCode message: nsk:Person:InvalidProgramCode type: Validation details: null rawMessage: The program code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Program Level Code: description: The program level code is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidProgramLevelCode message: nsk:Person:InvalidProgramLevelCode type: Validation details: null rawMessage: The program level code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/programs/{personProgramKey}: get: tags: - persons summary: Gets a specific program for a specific person. description: 'GraphQL endpoint: personProgram' operationId: nsk_v1_persons_personKey_programs_personProgramKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personProgramKey in: path required: true description: The unique program key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonCustomerProgram' put: tags: - persons summary: Updates a specific program for a specific person. description: 'GraphQL endpoint: personProgramSet' operationId: nsk_v1_persons_personKey_programs_personProgramKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personProgramKey in: path required: true description: The unique person program key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified program. content: application/json: schema: $ref: '#/components/schemas/PersonCustomerProgramEditRequest' examples: Person Customer Program Edit Request: description: Example request for updating a person's customer program. value: programNumber: '12345' effectiveDate: '2026-07-10T00:00:00+00:00' expirationDate: '2027-07-09T00:00:00+00:00' default: true programLevelCode: A required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Program Key: description: The person program key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonCustomerProgram' has failed. Please verify this object exists. 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. With Invalid Program Level Code: description: The program level code is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidProgramLevelCode message: nsk:Person:InvalidProgramLevelCode type: Validation details: null rawMessage: The program level code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches a specific program for a specific person. description: 'GraphQL endpoint: personProgramModify' operationId: nsk_v1_persons_personKey_programs_personProgramKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personProgramKey in: path required: true description: The unique person program key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched program. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonCustomerProgramEditRequest' examples: Person Customer Program Edit Request: description: Example request for updating a person's customer program. value: programNumber: '12345' effectiveDate: '2026-07-10T00:00:00+00:00' expirationDate: '2027-07-09T00:00:00+00:00' default: true programLevelCode: A required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Program Key: description: The person program key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personProgramKey' with value 'MTW' is invalid. type: Validation details: personProgramKey: MTW rawMessage: The identifier 'personProgramKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Program Level Code: description: The program level code is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidProgramLevelCode message: nsk:Person:InvalidProgramLevelCode type: Validation details: null rawMessage: The program level code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a specific program for a specific person. description: 'GraphQL endpoint: personProgramDelete' operationId: nsk_v1_persons_personKey_programs_personProgramKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personProgramKey in: path required: true description: The unique person program key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/storedPayments: get: tags: - persons summary: Gets the collection of stored payments for a specific person. description: Gets the collection of stored payments for a specific person. operationId: nsk_v1_persons_personKey_storedPayments_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonStoredPayment' post: tags: - persons summary: Creates a new stored payment for a specific person. description: 'GraphQL endpoint: personStoredPaymentAdd' operationId: nsk_v1_persons_personKey_storedPayments_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new stored payment. content: application/json: schema: $ref: '#/components/schemas/PersonStoredPaymentRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/storedPayments/{personStoredPaymentKey}: get: tags: - persons summary: Gets a specific stored payment for a specific person. description: 'GraphQL endpoint: personStoredPayment' operationId: nsk_v1_persons_personKey_storedPayments_personStoredPaymentKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personStoredPaymentKey in: path required: true description: The unique stored payment key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonStoredPayment' patch: tags: - persons summary: Patches a specific stored payment for a specific person. description: 'To update the account number please DELETE and POST a new stored payment. GraphQL endpoint: personStoredPaymentModify' operationId: nsk_v1_persons_personKey_storedPayments_personStoredPaymentKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personStoredPaymentKey in: path required: true description: The unique person stored payment key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched stored payment. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonStoredPaymentUpdateRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a specific stored payment for a specific person. description: 'GraphQL endpoint: personStoredPaymentDelete' operationId: nsk_v1_persons_personKey_storedPayments_personStoredPaymentKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personStoredPaymentKey in: path required: true description: The unique person stored payment key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/persons/{personKey}/storedPayments/{personStoredPaymentKey}: put: tags: - persons summary: Updates a specific stored payment for a specific person. description: 'To update the account number please DELETE and POST a new stored payment. GraphQL endpoint: personStoredPaymentSetv2' operationId: nsk_v2_persons_personKey_storedPayments_personStoredPaymentKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personStoredPaymentKey in: path required: true description: The unique person stored payment key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified stored payment. content: application/json: schema: $ref: '#/components/schemas/PersonStoredPaymentUpdateRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/travelDocuments: get: tags: - persons summary: Gets the collection of travel documents for a specific person. description: Gets the collection of travel documents for a specific person. operationId: nsk_v1_persons_personKey_travelDocuments_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonTravelDocument' post: tags: - persons summary: 'Creates a new travel document for a specific person. Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object. This is by design due to New Skies validation on the Gender property, and on the Travel Document Date of Birth being trusted over the person record Date of Birth.' description: 'GraphQL endpoint: personTravelDocumentAddv2' operationId: nsk_v1_persons_personKey_travelDocuments_post parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 requestBody: x-name: request description: The new travel document. content: application/json: schema: $ref: '#/components/schemas/PersonTravelDocumentRequest' examples: Person Travel Document Request: description: Example request for creating a person's travel document. value: default: true documentTypeCode: P birthCountry: US issuedByCode: US name: first: John middle: Cee last: Doe title: Mr. suffix: null nationality: US expirationDate: '2034-07-09T05:55:16.113889+00:00' number: P12345678 issuedDate: '2024-07-09T05:55:16.1138905+00:00' gender: 1 dateOfBirth: '2001-07-09T05:55:16.1138914+00:00' declaredGender: Male placeOfBirth: US placeOfIssue: US required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Travel Document Type: description: The travel document type provided is not valid or not configured in the system. value: errors: - id: null code: nsk:Person:InvalidTravelDocumentType message: nsk:Person:InvalidTravelDocumentType type: Validation details: null rawMessage: The document type code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Duplicate Travel Document: description: The travel document already exists. value: errors: - id: null code: nsk:Exceptions:DuplicateCreateFailed message: nsk:Exceptions:DuplicateCreateFailed type: Validation details: null rawMessage: Attempted create of object 'PersonTravelDocument' has failed. The object already exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/travelDocuments/{personTravelDocumentKey}: get: tags: - persons summary: Gets a specific travel document for a specific person. description: 'GraphQL endpoint: personTravelDocumentv2' operationId: nsk_v1_persons_personKey_travelDocuments_personTravelDocumentKey_get parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personTravelDocumentKey in: path required: true description: The unique travel document key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonTravelDocument' delete: tags: - persons summary: Deletes a specific travel document for a specific person. description: 'GraphQL endpoint: personTravelDocumentDeletev2' operationId: nsk_v1_persons_personKey_travelDocuments_personTravelDocumentKey_delete parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personTravelDocumentKey in: path required: true description: The unique person travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/persons/{personKey}/travelDocuments/{personTravelDocumentKey}: put: tags: - persons summary: Updates a specific travel document for a specific person. description: 'Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object. This is by design due to New Skies validation on the Gender property, and on the Travel Document Date of Birth being trusted over the person record Date of Birth. Once the declared gender is set in the travel document, it can only be set to other values. Setting the declared gender in the request to blank or null will not cause an error in the endpoint, but the existing value will be retained. GraphQL endpoint: personTravelDocumentSetv2' operationId: nsk_v2_persons_personKey_travelDocuments_personTravelDocumentKey_put parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personTravelDocumentKey in: path required: true description: The unique person travel document key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentEditRequestv2' examples: Person Travel Document Edit Request: description: Example request for updating a person's travel document. value: birthCountry: US name: first: John middle: Cee last: Doe title: Mr. suffix: null nationality: US expirationDate: '2034-07-09T05:55:16.1260596+00:00' number: P12345678 issuedDate: '2024-07-09T05:55:16.1260618+00:00' default: true gender: 1 dateOfBirth: '2001-07-09T05:55:16.1260623+00:00' declaredGender: Male placeOfBirth: US placeOfIssue: US required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Travel Document Key: description: The travel document key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid. type: Validation details: personTravelDocumentKey: MTW rawMessage: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches a specific travel document for a specific person. description: 'Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object. This is by design due to New Skies validation on the Gender property, and on the Travel Document Date of Birth being trusted over the person record Date of Birth. Once the declared gender is set in the travel document, it can only be set to other values. Setting the declared gender in the request to blank or null will not cause an error in the endpoint, but the existing value will be retained. GraphQL endpoint: personTravelDocumentModifyv2' operationId: nsk_v2_persons_personKey_travelDocuments_personTravelDocumentKey_patch parameters: - name: personKey in: path required: true description: The unique person key. schema: type: string x-position: 1 - name: personTravelDocumentKey in: path required: true description: The unique person travel document key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched travel document. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelDocumentEditRequestv2' examples: Person Travel Document Edit Request: description: Example request for updating a person's travel document. value: birthCountry: US name: first: John middle: Cee last: Doe title: Mr. suffix: null nationality: US expirationDate: '2034-07-09T05:55:16.1276505+00:00' number: P12345678 issuedDate: '2024-07-09T05:55:16.1276513+00:00' default: true gender: 1 dateOfBirth: '2001-07-09T05:55:16.1276516+00:00' declaredGender: Male placeOfBirth: US placeOfIssue: US required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Person Key: description: The person key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personKey' with value 'MTW' is invalid. type: Validation details: personKey: MTW rawMessage: The identifier 'personKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Travel Document Key: description: The travel document key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid. type: Validation details: personTravelDocumentKey: MTW rawMessage: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/travelNotifications: get: tags: - persons summary: Gets person travel notifications for a person. description: 'GraphQL endpoint: personsTravelNotifications' operationId: nsk_v1_persons_personKey_travelNotifications_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonTravelNotification' post: tags: - persons summary: Creates a person travel notification for a person. description: 'GraphQL endpoint: personsTravelNotificationAdd' operationId: nsk_v1_persons_personKey_travelNotifications_post parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 requestBody: x-name: request description: The travel notification create request. content: application/json: schema: $ref: '#/components/schemas/TravelNotificationCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}: get: tags: - persons summary: Gets a person travel notification for a person. description: 'GraphQL endpoint: personsTravelNotification' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonTravelNotification' put: tags: - persons summary: Updates a person travel notification for a person. description: 'GraphQL endpoint: personsTravelNotificationSet' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_put parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The travel notification edit request. content: application/json: schema: $ref: '#/components/schemas/TravelNotificationEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - persons summary: Patches a person travel notification for a person. description: 'GraphQL endpoint: personsTravelNotificationModify' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_patch parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The delta mapper travel notification edit request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelNotificationEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a person travel notification for a person. description: 'GraphQL endpoint: personsTravelNotificationDelete' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_delete parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/events: get: tags: - persons summary: Gets notification events for a person travel notification for a person. description: 'GraphQL endpoint: personsNotificationEvents' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_events_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - persons summary: Creates a notification event for a person travel notification for a person. description: 'GraphQL endpoint: personsNotificationEventAdd' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_events_post parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The notification event create request. content: application/json: schema: $ref: '#/components/schemas/NotificationEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/events/{eventType}: get: tags: - persons summary: Gets a notification event for a person travel notification for a person. description: 'GraphQL endpoint: personsNotificationEvent' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_events_eventType_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: eventType in: path required: true description: "The event type. \nEnumeration values: 0 = DepartureDelay, 1\ \ = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" schema: $ref: '#/components/schemas/NotificationEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNotificationEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a notification event from a person travel notification for a person. description: 'GraphQL endpoint: personsNotificationEventDelete' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_events_eventType_delete parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: eventType in: path required: true description: "The notification event type. \nEnumeration values: 0 = DepartureDelay,\ \ 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" schema: $ref: '#/components/schemas/NotificationEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/timedEvents: get: tags: - persons summary: Gets notification timed events for a person travel notification for a person. description: 'GraphQL endpoint: personsNotificationTimedEvents' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationTimedEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - persons summary: Creates a notification timed event for a person travel notification for a person. description: 'GraphQL endpoint: personsNotificationTimedEventAdd' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_post parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The notification timed even create request. content: application/json: schema: $ref: '#/components/schemas/NotificationTimedEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/persons/{personKey}/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType}: get: tags: - persons summary: Gets a notification timed event for a person travel notification for a person. description: 'GraphQL endpoint: personsNotificationTimedEvent' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_get parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The timed event type. \nEnumeration values: 0 = Departure, 1\ \ = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNotificationTimedEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - persons summary: Updates a notification timed event for a person travel notification for a person. description: 'GraphQL endpoint: personsNotificationTimedEventSet' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_put parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The notification timed event type. \nEnumeration values: 0 =\ \ Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 requestBody: x-name: request description: The updated notification timed event request. content: application/json: schema: $ref: '#/components/schemas/NotificationTimedEventEditRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - persons summary: Deletes a notification timed event from a person travel notification for a person. description: 'GraphQL endpoint: personsNotificationTimedEventDelete' operationId: nsk_v1_persons_personKey_travelNotifications_travelNotificationKey_timedEvents_timedEventType_delete parameters: - name: personKey in: path required: true description: The person key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The notification timed event type. \nEnumeration values: 0 =\ \ Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/apo/v1/pricing: post: tags: - pricing summary: Creates a pricing offer in the ancillary pricing options service. description: 'GraphQL endpoint: apoPricingAdd' operationId: apo_v1_pricing_post requestBody: x-name: request description: The price request. content: application/json: schema: $ref: '#/components/schemas/ApoPriceRequest' examples: APO pricing request: description: Example APO pricing request. value: currencyCode: USD passengerType: ADT externalBookingReference: '0' stage: 0 inputParameters: - code: AgentID values: - '1' - code: FareClass values: - S - code: JourneyDestinationCountryCode values: - A - code: JourneyDestinationLocationCode values: - A - code: JourneyOriginCountryCode values: - A - code: MarketingCarrierCode values: - A - code: NumberOfPassengers values: - '1' - code: TotalItineraryPrice values: - '720.0' - code: TripFirstTravelDate values: - '2079-07-23T14:20:00' - code: SegmentFirstTravelDate values: - '2079-07-23T14:20:00' - code: TripReturnTravelDate values: - '2079-07-24T14:20:00' - code: ChannelID values: - '1' - code: IPAddress values: - 127.0.0.1 - code: JourneyTravelTime values: - '395' - code: ResidentCountryCode values: - US - code: RoleName values: - SYSM - code: SegmentDestinationCountryCode values: - US - code: SegmentDestinationLocationCode values: - LAX - code: SegmentOriginCountryCode values: - US - code: SegmentOriginLocationCode values: - JFK - code: SegmentTravelTime values: - '395' - code: TotalFare values: - '720.0' - code: TripDestinationCountryCode values: - US - code: TripDestinationLocationCode values: - LAX - code: TripOriginCountryCode values: - US - code: TripOriginLocationCode values: - JFK - code: TripType values: - '2' valueTypes: - Price products: - productReference: '0' source: NS provider: FARE code: A variation: null type: DEF originalPrice: 100.0 cost: 0.0 available: -1 count: 1 segmentProductRatio: 1 inputParameters: null - productReference: '1' source: NS provider: FARE code: B variation: null type: DEF originalPrice: 100.0 cost: 0.0 available: -1 count: 1 segmentProductRatio: 1 inputParameters: null - productReference: '2' source: NS provider: FARE code: Z variation: null type: DEF originalPrice: 100.0 cost: 0.0 available: -1 count: 1 segmentProductRatio: 1 inputParameters: null - productReference: '3' source: NS provider: FARE code: B variation: null type: DEF originalPrice: 100.0 cost: 0.0 available: -1 count: 1 segmentProductRatio: 1 inputParameters: null required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPriceOffer' examples: APO price offers are created: description: Example when APO price offers are created. value: data: - type: Price productReference: '3' price: 90.0 currencyCode: USD probability: 0 offerCode: OfferDAPI acceptZero: true chargeCode: DISC points: 0 outputParameters: - key: MarketingCarrierCode value: A - key: NumberOfPassengers value: '1' - key: PaxType value: ADT - key: TotalItineraryPrice value: '720.0' - key: FareClass value: S - key: AgentID value: '1' - type: Price productReference: '1' price: 90.0 currencyCode: USD probability: 0 offerCode: OfferDAPI acceptZero: true chargeCode: DISC points: 0 outputParameters: - key: MarketingCarrierCode value: A - key: NumberOfPassengers value: '1' - key: PaxType value: ADT - key: TotalItineraryPrice value: '720.0' - key: FareClass value: S - key: AgentID value: '1' - type: Price productReference: '2' price: 90.0 currencyCode: USD probability: 0 offerCode: OfferDAPI acceptZero: true chargeCode: DISC points: 0 outputParameters: - key: MarketingCarrierCode value: A - key: NumberOfPassengers value: '1' - key: PaxType value: ADT - key: TotalItineraryPrice value: '720.0' - key: FareClass value: S - key: AgentID value: '1' - type: Price productReference: '3' price: 90.0 currencyCode: USD probability: 0 offerCode: OfferDAPI acceptZero: true chargeCode: DISC points: 0 outputParameters: - key: MarketingCarrierCode value: A - key: NumberOfPassengers value: '1' - key: PaxType value: ADT - key: TotalItineraryPrice value: '720.0' - key: FareClass value: S - key: AgentID value: '1' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: APO is not enabled: description: Example response when APO is not enabled. Please coordinate with your Navitaire account manager if this functionality needs to be enabled. value: errors: - id: null code: apo:General:NotEnabled message: The ancillary pricing options functionality is not enabled for the current environment. type: Critical details: null rawMessage: The ancillary pricing options functionality is not enabled for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/apo/v1/pricing/configuration: get: tags: - pricing summary: Gets the pricing configuration data from the ancillary pricing options service. description: 'GraphQL endpoint: apoPricingConfiguration' operationId: apo_v1_pricing_configuration_get parameters: - name: source in: query description: The pricing configuration source. schema: type: string nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPricingConfiguration' examples: APO pricing configuration response: description: Example APO pricing configuration response. value: data: chargeCode: DISC maximumOptimizePercentage: 1.0 settings: - code: CHRG value: DISC - code: DTRTPRD value: ALL - code: LOYFIL value: MonetaryOnly,PointsOnly,PointsAndMonetary - code: MAXBDL value: '1' - code: ACPTZRO value: 'FALSE' - code: MOPTP value: '1.0' providers: - code: Fare source: NS inputParameters: - AgentID - ChannelID - ClientName - CustomerHomeCity - FareClass - FirstPassengerHomeCity - GoverningFareBasisCode - GoverningFareClassOfService - GoverningFareType - GoverningProductClass - IPAddress - JourneyConnectingStationsList - JourneyDestinationCountryCode - JourneyDestinationLocationCode - JourneyEquipmentMarketingConfigurationList - JourneyEquipmentSalesConfigurationList - JourneyEquipmentTypeList - JourneyEquipmentTypeSuffixList - JourneyFareClassOfServiceList - JourneyFirstTravelDate - JourneyFlightType - JourneyHasMarketingCodeShare - JourneyHasOutboundInterline - JourneyMarketingCarrierCodeList - JourneyMarketingFlightNumberList - JourneyOperatingCarrierCodeList - JourneyOperatingFlightNumberList - JourneyOriginCountryCode - JourneyOriginLocationCode - JourneyOriginLocationCodeTimeZoneOffset - JourneySalesDate - JourneySoldAgentRoleCode - JourneySoldByLegByTravelClassList - JourneyTravelClassList - JourneyTravelTime - LoyaltyFilter - NumberOfPassengers - OverrideSamplingRandomNumber - ParentBookingID - ParentRecordLocator - PassengerDiscountCode - PricingDate - PromotionCode - RecordLocator - ResidentCountryCode - RoleName - SourceEndpoint - SourceOrganizationCode - SystemCode - TotalFare - TotalFareWithoutFeeAndTax - TotalItineraryPrice - TripDestinationCountryCode - TripDestinationLocationCode - TripFirstTravelDate - TripOriginCountryCode - TripOriginLocationCode - TripOriginLocationCodeTimeZoneOffsetMinutes - TripReturnTravelDate - TripType - WebSessionID products: - code: D variation: null type: null - code: B variation: null type: null - code: N variation: null type: null - code: A variation: null type: null - code: A variation: CR type: null - code: C variation: null type: null - code: C variation: CR type: null - code: C variation: CV type: null - code: B variation: null type: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: APO is not enabled: description: Example response when APO is not enabled. Please coordinate with your Navitaire account manager if this functionality needs to be enabled. value: errors: - id: null code: apo:General:NotEnabled message: The ancillary pricing options functionality is not enabled for the current environment. type: Critical details: null rawMessage: The ancillary pricing options functionality is not enabled for the current environment. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Source is null or empty: description: Example response when the source is null or empty. value: errors: - id: null code: apo:Pricing:EmptyPricingSource message: apo:Pricing:EmptyPricingSource type: Validation details: null rawMessage: The pricing configuration source is empty. A value must be set. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/promotions: get: tags: - promotions summary: Gets promotions based on data in the request. description: 'GraphQL endpoint: promotions' operationId: nsk_v1_promotions_get parameters: - name: PromotionCode in: query description: "The promotion code.\n " schema: type: string maxLength: 8 minLength: 0 nullable: true x-position: 1 - name: OrganizationCode in: query description: "The organization code.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 2 - name: EffectiveDate in: query description: "The effective date of the promotion.\n " schema: type: string format: date-time nullable: true x-position: 3 - name: CultureCode in: query description: "The requested culture code.\n " schema: type: string nullable: true x-position: 4 - name: PromotionCodeMatching in: query description: "The matching criteria for the promotion code, by default if\ \ not set the criteria will be an exact match.\n \nEnumeration\ \ values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 5 - name: OrganizationCodeMatching in: query description: "The matching criteria for the organization code, by default\ \ if not set the criteria will be an exact match.\n \nEnumeration\ \ values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 6 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPromotionBase' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/promotions/{promotionCode}: get: tags: - promotions summary: Gets a promotion based on the promotion code. description: 'GraphQL endpoint: promotion' operationId: nsk_v1_promotions_promotionCode_get parameters: - name: promotionCode in: path required: true description: The promotion code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPromotion' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/promotions/{promotionCode}/validate: get: tags: - promotions summary: 'Evaluates a promotion code and optional organization code to determine if the associated promotion is valid or not.' description: 'This validates the promotion code based on the logged-in user if the organization code is not provided. GraphQL endpoint: promotionValidate' operationId: nsk_v1_promotions_promotionCode_validate_get parameters: - name: promotionCode in: path required: true description: The promotion code. schema: type: string x-position: 1 - name: organizationCode in: query description: The optional organization code. schema: type: string nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/queues/bookings: get: tags: - queues summary: Gets the list of queues available. description: 'This action requires a session token. This endpoint has known issues where the total count returned is incorrect and on the first initial request, the count of the items returned is one less than the requested page size. This is an issue with the underlying NewSkies remoting call and a bug has been logged to fix these issues. GraphQL endpoint: bookingQueuesv2' operationId: nsk_v2_queues_bookings_get parameters: - name: QueueName in: query description: "Queue name.\n " schema: type: string nullable: true x-position: 1 - name: QueueCode in: query description: "Queue code.\n " schema: type: string nullable: true x-position: 2 - name: QueueCategoryCode in: query description: "Queue category code.\nPlease note that this should be a char\ \ and not a string.\n " schema: type: string maxLength: 1 nullable: true x-position: 3 - name: PageSize in: query description: "The default page size.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: LastPageIndex in: query description: "Used to specify the index of the last set of records retrieved\n\ when paging is performed. This is optional.\n " schema: type: integer format: int32 nullable: true x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfQueueResults' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/queues/bookings/{bookingQueueCode}/items: delete: tags: - queues summary: Empties the booking queue. description: 'GraphQL endpoint: bookingQueueEmpty' operationId: nsk_v1_queues_bookings_bookingQueueCode_items_delete parameters: - name: bookingQueueCode in: path required: true description: The booking queue code. schema: type: string x-position: 1 - name: subQueueCode in: query description: The sub-queue code. schema: type: string nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/queues/bookings/{bookingQueueCode}/items/{bookingQueueItemKey}: put: tags: - queues summary: Moves to a different queue. description: 'The booking queue proxy and service model do not currently support getting the queue code the item was moved to. Therefore, it is not possible at this time to provide a link to access the item on a different queue or a configurable response containing the queue object. Additionally, the proxy and service model do not allow for getting a particular item within a queue. GraphQL endpoint: bookingQueueMoveItem' operationId: nsk_v1_queues_bookings_bookingQueueCode_items_bookingQueueItemKey_put parameters: - name: bookingQueueCode in: path required: true description: The identifier for the particular booking queue schema: type: string x-position: 1 - name: bookingQueueItemKey in: path required: true description: The identifier for the booking queue item. schema: type: string x-position: 2 requestBody: x-name: request description: The request for the move. content: application/json: schema: $ref: '#/components/schemas/MoveBookingQueueItemBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Booking already in queue: description: Example error when trying to move a booking to another queue, and the booking is already in the target queue. value: errors: - id: null code: nsk-server:BookingAlreadyInQueue message: nsk-server:BookingAlreadyInQueue type: Information details: null rawMessage: 'Booking is already on queue: ''DAPI'', BookingID = 127160, BookingQueueItemID = 0, SegmentKey = ''''.' 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 delete: tags: - queues summary: Removes booking queue items from the specified queue. description: 'GraphQL endpoint: bookingQueueDeleteItem' operationId: nsk_v1_queues_bookings_bookingQueueCode_items_bookingQueueItemKey_delete parameters: - name: bookingQueueCode in: path required: true description: The identifier of the booking queue containing the item to delete. schema: type: string x-position: 1 - name: bookingQueueItemKey in: path required: true description: The identifier of the booking queue item to delete. schema: type: string x-position: 2 requestBody: x-name: request description: The request for the booking queue item to delete. content: application/json: schema: $ref: '#/components/schemas/DeleteBookingQueueItemBaseRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid bookingQueueItemKey error: description: Example error when bookingQueueItemKey is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'bookingQueueItemKey' with value 'ABCDE' is invalid. type: Validation details: bookingQueueItemKey: ABCDE 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 /api/nsk/v2/queues/bookings/{bookingQueueCode}/next: get: tags: - queues summary: Gets the next item in the booking queue. description: 'This will not delete the item from the queue. This action requires a session token. GraphQL endpoint: bookingQueueNextItemv2' operationId: nsk_v2_queues_bookings_bookingQueueCode_next_get parameters: - name: bookingQueueCode in: path required: true description: booking queue code to get next item from. schema: type: string x-position: 1 - name: SubQueueCode in: query description: "The optional sub queue code.\n " schema: type: string nullable: true x-position: 2 - name: StartDate in: query description: "Begin priority date.\n " schema: type: string format: date-time nullable: true x-position: 3 - name: EndDate in: query description: "End priority date.\n " schema: type: string format: date-time nullable: true x-position: 4 - name: Password in: query description: "The Password needed to access the queue. Required if queue\n\ is set to password-protected in Sky Manager.\n " schema: type: string nullable: true x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingQueueItemBase' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/queues/bookings/items/{bookingQueueItemKey}: post: tags: - queues summary: Places the booking queue item back on the queue. description: 'This is solely to return existing booking queue items that have been dequeued (not deleted) via GET `/api/nsk/v2/queues/bookings/{bookingQueueCode}/next`. GraphQL endpoint: bookingQueueReleaseItem' operationId: nsk_v1_queues_bookings_items_bookingQueueItemKey_post parameters: - name: bookingQueueItemKey in: path required: true description: The booking queue item key. schema: type: string x-position: 1 - name: password in: query description: The password needed to access the queue. schema: type: string nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/queues/bookings/items/{bookingQueueItemKey}: post: tags: - queues summary: Places the booking queue item back on the queue. description: 'This is solely to return existing booking queue items that have been dequeued (not deleted) via GET `/api/nsk/v2/queues/bookings/{bookingQueueCode}/next`.' operationId: nsk_v2_queues_bookings_items_bookingQueueItemKey_post parameters: - name: bookingQueueItemKey in: path required: true description: The booking queue item key. schema: type: string x-position: 1 requestBody: x-name: request description: The request object, with password needed to access the queue. content: application/json: schema: $ref: '#/components/schemas/BookingQueueReleaseRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/queues/bookings/queueEvents/{queueEventType}: get: tags: - queues summary: Gets the list of booking queues that match the specified event type. description: 'This action requires a session token. "Default" or "0" is not a valid queue event type and would return a 400 Bad Request. GraphQL endpoint: bookingQueuesByEventType' operationId: nsk_v1_queues_bookings_queueEvents_queueEventType_get parameters: - name: queueEventType in: path required: true description: "The queue event type. \nEnumeration values: 0 = Default, 1 =\ \ BookingBalanceDue, 2 = BookingNegativeBalance, 3 = BookingCustomerComment,\ \ 4 = DeclinedPaymentInitial, 5 = DeclinedPaymentChange, 6 = FareOverride,\ \ 7 = ScheduleTimeChange, 8 = ScheduleTimeChangeMisconnect, 9 = ScheduleCancellation,\ \ 10 = FlightDesignatorChange, 11 = ReaccommodationMove, 12 = GdsCancelWithPendingPayment,\ \ 13 = InvalidPriceStatusOverride, 14 = FareRestrictionOverride, 15 = HeldBookings,\ \ 16 = InvalidPriceStatus, 17 = Watchlist, 18 = NonFlightServiceFee, 19\ \ = NotAllTicketNumbersReceived, 20 = BookingSegmentOversold, 21 = ReaccommodationCancel,\ \ 22 = ExternalSsrAutoConfirmed, 23 = OpCarrierSegUpdate, 24 = OpCarrierSsrUpdate,\ \ 25 = OpCarrierOtherUpdate, 26 = NameChangeNotAllowed, 27 = InboundAscNotProcessed,\ \ 28 = OpCarrierInformationChange, 29 = BookingComponentUpdate, 30 = GroupBookings,\ \ 31 = BankDirectPnrOutOfBalance, 32 = NoSeatAssigned, 33 = SeatNumberChange,\ \ 34 = SsrNotSupportedOnNewSeat, 35 = FewerSeatPreferencesMetOnNewSeat,\ \ 36 = AosUnableToConfirmCancel, 37 = ETicketIssue, 38 = ETicketFollowup,\ \ 39 = InvoluntaryFlyAhead, 40 = ManualClearanceOnOutage, 41 = UnbalancedPoints,\ \ 42 = OpCarrierTimeChange, 43 = OaCarrierTimeChange, 44 = VoluntaryFlightChange,\ \ 45 = InvoluntaryFlightChange, 46 = HoldCancellationFailed, 47 = ScheduleTimeChangeWithDynamicQueueCode,\ \ 48 = ReaccommodationMoveWithDynamicQueueCode, 49 = ItineraryIntegrity,\ \ 50 = ReducePartyNotProcessed, 51 = CheckedPassengerUpdate, 52 = MustBeSeatGroupViolation,\ \ 57 = NameChangeWithinRule, 58 = IncompletePassengerEMDCoupon, 59 = ASVCUpdateFailed,\ \ 60 = FailedFareClassRealignment, 61 = ScheduleTimeChangeMisconnectBelowMinimum,\ \ 62 = ScheduleTimeChangeMisconnectAboveMaximum, 63 = OpCarrierMisconnect,\ \ 64 = InventoryQueuing, 65 = SelfServiceAsm, 66 = SelfServiceDelay, 67\ \ = SelfServiceFlightCancellation, 68 = SelfServiceIrop, 69 = SelfServiceScheduleChange,\ \ 70 = SelfServiceTimeChange, 71 = AosAddOrCancelNotSuccessful, 72 = MissingGdsFareFamily,\ \ 73 = ChangeCabinQueue, 74 = PendingPaymentQueue, 75 = TicketDisplayToDetermineIncludedServiceBundleFailed,\ \ 76 = DuplicateTicketsInBooking, 77 = TicketCouponUpdateQueue, 78 = ETicketRefund,\ \ 79 = ExternalEticketVoidCheck, 80 = ExternalEticketVoidCheckFollowUp,\ \ 81 = NoAssignedSeatOnNewFlightFromEquipmentChange" schema: $ref: '#/components/schemas/QueueEventType' x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfQueue' examples: With matching queues: description: Example when queues match the specified queue event type. value: data: - queueCode: ORATCH subQueueCode: null queueCategoryCode: S name: ORA Time Change totalBookings: 20 restriction: 2 hasPassword: false status: 0 No matching queues: description: Example when no queues match the specified event type on the query parameter. value: data: [] '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid queue event type: description: Example when the queue event type is invalid. value: errors: - id: 7387c8d5-d11a-f4f0-cc8b-7487d7c0990a code: nsk:Queues:QueueEventTypeInvalid message: nsk:Queues:QueueEventTypeInvalid type: Validation details: null rawMessage: Queue event type is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. messages: - rawValue: The value 'kk' is not valid. code: core:Validation:MalformedRequest debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: Information value: core:Validation:MalformedRequest status: 1 details: null data: null Default queue event type: description: Example when the queue event type is Default or 0. value: errors: - id: 2a229cf0-263b-78cd-4233-43ad8a1d1171 code: nsk:Queues:QueueEventTypeInvalid message: nsk:Queues:QueueEventTypeInvalid type: Validation details: null rawMessage: Queue event type is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/queues/travel: post: tags: - queues summary: Creates a new travel queue entry. description: 'This action requires a session token. GraphQL endpoint: travelQueueEnqueueItem' operationId: nsk_v1_queues_travel_post requestBody: x-name: item description: The travel queue item request object. content: application/json: schema: $ref: '#/components/schemas/TravelQueueItemRequest' required: true x-position: 1 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/queues/travel/{travelQueueCode}/next: get: tags: - queues summary: Pops the next item in the travel queue. description: 'This will delete the item from the queue. This action requires a session token. GraphQL endpoint: travelQueueNextItem' operationId: nsk_v1_queues_travel_travelQueueCode_next_get parameters: - name: travelQueueCode in: path required: true description: Travel queue code to get next item from. schema: type: string x-position: 1 - name: subQueueCode in: query description: Sub queue code. schema: type: string nullable: true x-position: 2 responses: '200': description: Returned successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDequeueTravelSummary' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/v1/redis: get: tags: - redis summary: Gets all the cache items that exist in redis. description: Gets all the cache items that exist in redis. operationId: v1_redis_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfString' examples: Ok: description: Data results are based on the current cache. value: data: - Mac - FlightSearchSettings - Station '401': description: Your token is unauthorized to use this endpoint. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Not Allowed: description: Role permissions is not allowed. Please see the developer documentation portal for more information. value: errors: - id: null code: core:Caching:CacheManagementNotAllowed message: null type: Error details: null rawMessage: The current token's permissions are not allowed to manage the redis cache. 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 '400': description: A bad request was submitted. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Not Enabled: description: Please, log a SNOW request to enable this ability. value: errors: - id: null code: core:Caching:CacheManagementNotAllowed message: null type: Error details: null rawMessage: The ability to manage redis cache is not enabled. Please change the 'ManagementEnabled' flag in the 'RedisConfiguration' section in the JSON. 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 delete: tags: - redis summary: Deletes all cache items. description: 'This will ignore all session values. If an in memory cache is configured via "cacheOptions.serverCache" (default is 5 minutes) other API instances may still have locally stale cached data for the configured time.' operationId: v1_redis_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Ok: description: No content returned. value: data: null '401': description: Your token is unauthorized to use this endpoint. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Not Allowed: description: Role permissions is not allowed. Please see the developer documentation portal for more information. value: errors: - id: null code: core:Caching:CacheManagementNotAllowed message: null type: Error details: null rawMessage: The current token's permissions are not allowed to manage the redis cache. 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 '400': description: A bad reqeust was submitted. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Resource Not Found: description: The value was not found. value: errors: - id: null code: core:Validation:ResourceNotFound message: null type: Error details: name: '{parameter name}' value: '{parameter value}' rawMessage: The data you are trying to access is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/v1/redis/{name}: delete: tags: - redis summary: Deletes a specific cache item from redis based on the cache item name. description: 'If an in memory cache is configured via "cacheOptions.serverCache" (default is 5 minutes) other API instances may still have locally stale cached data for the configured time.' operationId: v1_redis_name_delete parameters: - name: name in: path required: true description: The name of the cache item. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Ok: description: No content returned. value: data: null '401': description: Your token is unauthorized to use this endpoint. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Not Allowed: description: Role permissions is not allowed. Please see the developer documentation portal for more information. value: errors: - id: null code: core:Caching:CacheManagementNotAllowed message: null type: Error details: null rawMessage: The current token's permissions are not allowed to manage the redis cache. 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 '400': description: A bad reqeust was submitted. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Required Argument: description: Check url arguments. value: errors: - id: null code: core:Validation:RequiredArgument message: null type: Error details: argument: '{argument}' rawMessage: The request is missing a required argument expected in the request. 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 Resource Not Found: description: Check url argument. value: errors: - id: null code: core:Validation:ResourceNotFound message: null type: Error details: name: '{parameter name}' value: '{parameter value}' rawMessage: The data you are trying to access is not valid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/resources/AccountTransactionCodes: get: tags: - resources summary: Retrieves the collection of account transaction code resources. description: 'GraphQL endpoint: resourceAccountTransactionCodes' operationId: nsk_v1_resources_AccountTransactionCodes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAccountTransactionCode' /api/nsk/v1/resources/AccountTransactionCodes/{transactionCode}: get: tags: - resources summary: Retrieves the specific account transaction code resource. description: 'GraphQL endpoint: resourceAccountTransactionCode' operationId: nsk_v1_resources_AccountTransactionCodes_transactionCode_get parameters: - name: transactionCode in: path required: true description: The desired transaction code to retrieve. schema: type: string x-position: 1 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAccountTransactionCode' /api/nsk/v1/resources/AddressTypes: get: tags: - resources summary: Retrieves the collection of address type resources. description: 'GraphQL endpoint: resourceAddressTypes' operationId: nsk_v1_resources_AddressTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAddressType' /api/nsk/v1/resources/AddressTypes/{addressTypeCode}: get: tags: - resources summary: Retrieves the specific address type resource. description: 'GraphQL endpoint: resourceAddressType' operationId: nsk_v1_resources_AddressTypes_addressTypeCode_get parameters: - name: addressTypeCode in: path required: true description: The unique type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAddressType' /api/nsk/v1/resources/Areas: get: tags: - resources summary: Retrieves the collection of area resources. description: 'GraphQL endpoint: resourceAreas' operationId: nsk_v1_resources_Areas_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfArea' /api/nsk/v1/resources/Areas/{areaCode}: get: tags: - resources summary: Retrieves the specific area resource. description: 'See `/api/nsk/v1/resources/areas/{areaCode}/zones` to retrieve the list of geographical zones associated with a specific area. GraphQL endpoint: resourceArea' operationId: nsk_v1_resources_Areas_areaCode_get parameters: - name: areaCode in: path required: true description: The unique area code. schema: type: string x-position: 1 - name: cultureCode in: query description: The unique culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfArea' /api/nsk/v1/resources/Areas/{areaCode}/zones: get: tags: - resources summary: Retrieves the collection of zones resources. description: 'GraphQL endpoint: resourceZonesv2' operationId: nsk_v1_resources_Areas_areaCode_zones_get parameters: - name: areaCode in: path required: true description: The unique code of the area to which the zones belong. schema: type: string x-position: 1 - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 2 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 3 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 4 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 6 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfZonev2' /api/nsk/v1/resources/Areas/{areaCode}/zones/{zoneCode}: get: tags: - resources summary: Retrieves the specific zone resource. description: 'GraphQL endpoint: resourceZonev2' operationId: nsk_v1_resources_Areas_areaCode_zones_zoneCode_get parameters: - name: areaCode in: path required: true description: The unique code of the area to which the zone belongs. schema: type: string x-position: 1 - name: zoneCode in: path required: true description: The unique zone code. schema: type: string x-position: 2 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfZonev2' /api/nsk/v1/resources/BaggageTypes: get: tags: - resources summary: Retrieves the collection of baggage type resources. description: 'GraphQL endpoint: resourceBaggageTypes' operationId: nsk_v1_resources_BaggageTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBaggageType' examples: Retrieve baggage types response: description: Example response for successfully retrieving the configured baggage types in the system. value: data: - baggageTypeCode: 1BAG bagWeightType: 2 freeBag: false inActive: false name: Booking Baggage Allowance weightReducedBy: 5 includeInBaggageCount: false - baggageTypeCode: BSMX bagWeightType: 2 freeBag: false inActive: false name: BSM ExceptionTesting weightReducedBy: 0 includeInBaggageCount: false - baggageTypeCode: BSM3 bagWeightType: 1 freeBag: false inActive: false name: BSM Exception Testing weightReducedBy: 0 includeInBaggageCount: false - baggageTypeCode: MUSIC bagWeightType: 1 freeBag: false inActive: false name: Musical Equipment weightReducedBy: 5 includeInBaggageCount: false - baggageTypeCode: BSME bagWeightType: 0 freeBag: true inActive: false name: OPS Baggage - DO NOT EDIT weightReducedBy: 0 includeInBaggageCount: false - baggageTypeCode: MEDIC bagWeightType: 0 freeBag: true inActive: false name: Medical Equipment weightReducedBy: 0 includeInBaggageCount: false /api/nsk/v1/resources/BaggageTypes/{baggageTypeCode}: get: tags: - resources summary: Retrieves the specific baggage type resource. description: 'GraphQL endpoint: resourceBaggageType' operationId: nsk_v1_resources_BaggageTypes_baggageTypeCode_get parameters: - name: baggageTypeCode in: path required: true description: The unique baggage type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBaggageType' /api/nsk/v1/resources/bundles: get: tags: - resources summary: Retrieves the collection of bundle configuration resources. description: 'GraphQL endpoint: bundles' operationId: nsk_v1_resources_bundles_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleConfiguration' examples: Retrieve the collection of bundle configuration resources: description: Example response for successfully retrieving the collection of bundle configuration resources. value: data: - bundleCode: CC02 feeCode: CCBF bookingQueueCode: CALLC programCode: CC programLevel: Plus name: Call Center Application Plus description: "[All legs - Fixed pricing]\r\n10kg checked-in\ \ baggage\r\nThe healthy choice snack > Hot Meal Combo" hasPrice: true rank: 2 inActive: false allSsrsRequired: false serviceBundleType: 1 - bundleCode: BSC feeCode: null bookingQueueCode: NFSVCF programCode: null programLevel: null name: Basics Included Bundle description: Basic Included Bundle - SSR hasPrice: false rank: 1 inActive: false allSsrsRequired: false serviceBundleType: 0 - bundleCode: CC14 feeCode: CCBF bookingQueueCode: null programCode: null programLevel: null name: Call Center Application Business description: "[No Upgrades / All legs]\r\n30kg of baggage\r\n\ Hot Meal Combo\r\n*WIFI" hasPrice: true rank: 4 inActive: true allSsrsRequired: true serviceBundleType: 1 /api/nsk/v1/resources/bundles/{bundleCode}: get: tags: - resources summary: Retrieves a specific bundle configuration based on the bundle code. description: 'GraphQL endpoint: bundle' operationId: nsk_v1_resources_bundles_bundleCode_get parameters: - name: bundleCode in: path required: true description: The bundle code. schema: type: string x-position: 1 - name: cultureCode in: query description: The culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBundleConfiguration' examples: Get Bundle By Bundle Code Response: description: Example response for successfully retrieving a bundle by bundle code value: data: bundleCode: CC02 feeCode: CCBF bookingQueueCode: CALLC programCode: CC programLevel: Plus name: Call Center Application Plus description: "[All legs - Fixed pricing]\r\n10kg checked-in\ \ baggage\r\nThe healthy choice snack > Hot Meal Combo" hasPrice: true rank: 2 inActive: false allSsrsRequired: false serviceBundleType: 1 /api/nsk/v1/resources/bundles/applications: get: tags: - resources summary: Retrieves the collection of bundle application resources. description: 'See api/nsk/v1/bundles/application/{bundleApplicationKey}/details to retrieve additional bundle application details. The application details consist of three lists: carrier codes, product classes, and classes of service. GraphQL endpoint: bundleApplications' operationId: nsk_v1_resources_bundles_applications_get parameters: - name: BundleRuleCode in: query description: "The bundle rule code.\n " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 1 - name: CultureCode in: query description: "The specific culture code.\n " schema: type: string nullable: true x-position: 2 - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleApplication' /api/nsk/v1/resources/bundles/rules: get: tags: - resources summary: Retrieves the collection of bundle rule resources. description: 'See api/nsk/v1/bundles/rule/{bundleRuleCode}/details to retrieve a list of bundle applications associated with a specific bundle rule. Bundle rules are used to control where and how bundle applications are used. GraphQL endpoint: bundleRules' operationId: nsk_v1_resources_bundles_rules_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleRule' /api/nsk/v1/resources/bundles/sets: get: tags: - resources summary: Retrieves the collection of bundle set resources. description: 'See api/nsk/v1/bundles/set/{bundleSetCode}/details to retrieve a list of bundle codes associated with a specific bundle set. GraphQL endpoint: bundleSets' operationId: nsk_v1_resources_bundles_sets_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleSet' /api/nsk/v1/resources/bundles/ssrs: get: tags: - resources summary: 'Retrieves the collection of bundle ssr configurations associated with the bundle code.' description: 'GraphQL endpoint: bundleSsrs' operationId: nsk_v1_resources_bundles_ssrs_get parameters: - name: BundleCode in: query description: "The bundle code.\n " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 1 - name: CultureCode in: query description: "The specific culture code.\n " schema: type: string nullable: true x-position: 2 - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleSsrConfiguration' /api/nsk/v1/resources/carriers: get: tags: - resources summary: Retrieves the collection of carrier resources. description: 'GraphQL endpoint: resourceCarriers' operationId: nsk_v1_resources_carriers_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCarrier' /api/nsk/v1/resources/carriers/{carrierCode}: get: tags: - resources summary: Retrieves a single carrier. description: 'GraphQL endpoint: resourceCarrierv2' operationId: nsk_v1_resources_carriers_carrierCode_get parameters: - name: carrierCode in: path required: true description: The unique carrier code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCarrier' /api/nsk/v1/resources/Cities: get: tags: - resources summary: Retrieves the collection of city resources. description: 'GraphQL endpoint: resourceCities' operationId: nsk_v1_resources_Cities_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCity' /api/nsk/v1/resources/Cities/{cityCode}: get: tags: - resources summary: Retrieves the specific city resource. description: 'GraphQL endpoint: resourceCity' operationId: nsk_v1_resources_Cities_cityCode_get parameters: - name: cityCode in: path required: true description: The unique city code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCity' /api/nsk/v1/resources/ClassOfServices: get: tags: - resources summary: Retrieves the collection of class of service resources. description: 'GraphQL endpoint: resourceClassOfServices' operationId: nsk_v1_resources_ClassOfServices_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfClassOfService' /api/nsk/v1/resources/ClassOfServices/{classOfServiceCode}: get: tags: - resources summary: Retrieves the resource. description: 'GraphQL endpoint: resourceClassOfService' operationId: nsk_v1_resources_ClassOfServices_classOfServiceCode_get parameters: - name: classOfServiceCode in: path required: true description: The unique class of service code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfClassOfService' /api/nsk/v1/resources/CommissionRates: get: tags: - resources summary: Retrieves the collection of commission rate resources. description: 'GraphQL endpoint: resourceCommissionRates' operationId: nsk_v1_resources_CommissionRates_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCommissionRate' /api/nsk/v1/resources/CommissionRates/{commissionRateCode}: get: tags: - resources summary: Retrieves the specific commission rate resource. description: 'GraphQL endpoint: resourceCommissionRate' operationId: nsk_v1_resources_CommissionRates_commissionRateCode_get parameters: - name: commissionRateCode in: path required: true description: The unique commission rate code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCommissionRate' /api/nsk/v1/resources/ContactTypes: get: tags: - resources summary: Retrieves the collection of contact type resources. description: 'GraphQL endpoint: resourceContactTypes' operationId: nsk_v1_resources_ContactTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfContactType' /api/nsk/v1/resources/ContactTypes/{contactTypeCode}: get: tags: - resources summary: Retrieves the specific contact type resource. description: 'GraphQL endpoint: resourceContactType' operationId: nsk_v1_resources_ContactTypes_contactTypeCode_get parameters: - name: contactTypeCode in: path required: true description: The unique contact type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfContactType' /api/nsk/v1/resources/contents: get: tags: - resources summary: Searches the contents based on the search criteria provided. description: Searches the contents based on the search criteria provided. operationId: nsk_v1_resources_contents_get parameters: - name: Name in: query description: "Name of the content.\n " schema: type: string nullable: true x-position: 1 - name: Type in: query description: "Specific content type.\n \nEnumeration values: 0\ \ = GeneralReference, 1 = News, 2 = ConsoleHelp, 3 = FareRuleReference,\ \ 4 = ReviewWithCustomer, 8 = Image, 9 = PromotionReference, 10 = SubscriptionReference" schema: nullable: true $ref: '#/components/schemas/ContentType' x-position: 2 - name: ContainerId in: query description: "Unique id of the container.\n " schema: type: integer format: int64 nullable: true x-position: 3 - name: PageSize in: query description: "The default page size.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: LastContentId in: query description: "Used to specify the last item of the page of the last set of\ \ records retrieved\nwhen paging was performed. This is optional.\n \ \ " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 5 responses: '200': description: Search content succeeded. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIEnumerableOfResourceContentResult' /api/nsk/v1/resources/contents/{contentId}: get: tags: - resources summary: Retrieves a resource setting and its related information. description: 'This is a post to easily allow special path characters. See /resources/settings/data to avoid manually parsing the data.' operationId: nsk_v1_resources_contents_contentId_get parameters: - name: contentId in: path required: true description: The content id. schema: type: integer format: int64 x-position: 1 - name: convertRtfToHtml in: query description: The bool to determine whether or not to convert RTF to HTML data. schema: type: boolean nullable: true x-position: 2 - name: eTag in: query description: ETag for caching. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfResourceContentItem' delete: tags: - resources summary: Deletes a content item. description: 'This endpoint currently only supports deleting news content items. Deletion of other content types will be supported in the future. GraphQL endpoint: resourceContentDeletev2' operationId: nsk_v1_resources_contents_contentId_delete parameters: - name: contentId in: path required: true description: The content identifier. schema: type: integer format: int64 x-position: 1 responses: '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Deleting content is not allowed: description: Example when deleting content is not allowed. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:Content:DeleteContentNotAllowed message: nsk:Content:DeleteContentNotAllowed type: Validation details: null rawMessage: Deleting content is not allowed. 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 Deleting news is not allowed: description: Example when deleting news is not allowed. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:Content:DeleteNewsNotAllowed message: nsk:Content:DeleteNewsNotAllowed type: Validation details: null rawMessage: Deleting news is not allowed. 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 Content does not exist: description: Example when the content does not exist. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:Content:ContentDoesNotExist message: nsk:Content:ContentDoesNotExist type: Validation details: null rawMessage: The content does not exist. 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 Deleting non-news content: description: Example when the content is not a news. Non-news content deletion is currently not supported. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:Content:DeleteNonNewsContentNotSupported message: nsk:Content:DeleteNonNewsContentNotSupported type: Validation details: null rawMessage: Deleting non-news content is currently not supported. 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 Content ID is null.: description: Example when the content ID is null. It can be set to null by setting it to a URL encoded space value `%20` or to a value that cannot be converted to type `long`. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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 '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Content deleted successfully: description: Example when the content deleted successfully. value: data: null /api/nsk/v1/resources/contents/{contentId}/data: get: tags: - resources summary: Retrieves resource setting data based on the accept content type. description: 'This is a post to easily allow special path characters. If the data returned is not in HTML format and convertRtfToHtml is set to true, the content requested was of an incompatible data type.' operationId: nsk_v1_resources_contents_contentId_data_get parameters: - name: contentId in: path required: true description: The content id. schema: type: integer format: int64 x-position: 1 - name: convertRtfToHtml in: query description: The bool to determine whether or not to convert RTF to HTML data. schema: type: boolean nullable: true x-position: 2 - name: eTag in: query description: ETag for caching. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: type: string format: byte /api/nsk/v2/resources/countries: get: tags: - resources summary: Retrieves the collection of country resources. description: 'GraphQL endpoint: resourceCountriesv2' operationId: nsk_v2_resources_countries_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCountryv2' /api/nsk/v2/resources/countries/{countryCode}: get: tags: - resources summary: Retrieves a specific country resource. description: 'GraphQL endpoint: resourceCountryv2' operationId: nsk_v2_resources_countries_countryCode_get parameters: - name: countryCode in: path required: true description: The unique country code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCountryv2' /api/nsk/v1/resources/cultures: get: tags: - resources summary: Retrieves the resources. description: 'GraphQL endpoint: resourceCultures' operationId: nsk_v1_resources_cultures_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCulture' /api/nsk/v1/resources/cultures/{cultureCode}: get: tags: - resources summary: Retrieves the resource. description: 'GraphQL endpoint: resourceCulture' operationId: nsk_v1_resources_cultures_cultureCode_get parameters: - name: cultureCode in: path required: true description: The unique culture code. schema: type: string x-position: 1 - name: forCultureCode in: query description: The for culture. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCulture' /api/nsk/v2/resources/currencies: get: tags: - resources summary: Retrieves the collection of currency resources. description: 'GraphQL endpoint: resourceCurrenciesv2' operationId: nsk_v2_resources_currencies_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCurrencyv2' /api/nsk/v2/resources/currencies/{currencyCode}: get: tags: - resources summary: Retrieves the specific currency resource. description: 'GraphQL endpoint: resourceCurrencyv2' operationId: nsk_v2_resources_currencies_currencyCode_get parameters: - name: currencyCode in: path required: true description: The unique currency code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCurrencyv2' /api/nsk/v2/resources/customerPrograms: get: tags: - resources summary: Retrieves the collection of customer program resources. description: 'GraphQL endpoint: resourceCustomerProgramsv2' operationId: nsk_v2_resources_customerPrograms_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCustomerProgramv2' examples: Retrieve Customer Programs v2 Response: description: Example response for successfully retrieving the customer programs v2 resources value: data: programCode: ABC name: ABC Customer Program programType: 1 inActive: false customerProgramLevels: - programCode: ABC programLevelCode: LV1 name: ABC Level 1 shortName: ABC Level 1 displayCode: '1' rank: 1 inActive: false customerProgramSettings: - programCode: NV programLevel: NV1 settingCode: BoardingZone sequenceNumber: 1 settingValue: '1' checkDigitType: 1 /api/nsk/v1/resources/CustomerPrograms: get: tags: - resources summary: Retrieves the collection of customer program resources. description: 'GraphQL endpoint: resourceCustomerPrograms' operationId: nsk_v1_resources_CustomerPrograms_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCustomerProgram' deprecated: true /api/nsk/v2/resources/customerPrograms/{programCode}: get: tags: - resources summary: Retrieves the specific customer program resource. description: 'GraphQL endpoint: resourceCustomerProgramv2' operationId: nsk_v2_resources_customerPrograms_programCode_get parameters: - name: programCode in: path required: true description: The unique program code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerProgramv2' examples: Retrieve Customer Programs v2 Response: description: Example response for successfully retrieving the customer programs v2 resources value: data: programCode: ABC name: ABC Customer Program programType: 1 inActive: false customerProgramLevels: - programCode: ABC programLevelCode: LV1 name: ABC Level 1 shortName: ABC Level 1 displayCode: '1' rank: 1 inActive: false customerProgramSettings: - programCode: NV programLevel: NV1 settingCode: BoardingZone sequenceNumber: 1 settingValue: '1' checkDigitType: 1 /api/nsk/v1/resources/CustomerPrograms/{programCode}: get: tags: - resources summary: Retrieves the specific customer program resource. description: 'GraphQL endpoint: resourceCustomerProgram' operationId: nsk_v1_resources_CustomerPrograms_programCode_get parameters: - name: programCode in: path required: true description: The unique program code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerProgram' deprecated: true /api/nsk/v1/resources/CustomerPrograms/{programCode}/levels/{programLevelCode}: get: tags: - resources summary: Retrieves the specific program level. description: Retrieves the specific program level. operationId: nsk_v1_resources_CustomerPrograms_programCode_levels_programLevelCode_get parameters: - name: programCode in: path required: true description: The unique program code. schema: type: string x-position: 1 - name: programLevelCode in: path required: true description: The unique program level code. schema: type: string x-position: 2 - name: cultureCode in: query description: The culture code. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerProgramLevel' /api/nsk/v1/resources/Delays: get: tags: - resources summary: Retrieves the collection of delay resources. description: 'GraphQL endpoint: resourceDelays' operationId: nsk_v1_resources_Delays_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfDelay' /api/nsk/v1/resources/Delays/{delayCode}: get: tags: - resources summary: Retrieves the specific delay resource. description: 'GraphQL endpoint: resourceDelay' operationId: nsk_v1_resources_Delays_delayCode_get parameters: - name: delayCode in: path required: true description: The unique delay code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDelay' /api/nsk/v1/resources/Departments: get: tags: - resources summary: Retrieves the collection of department resources. description: 'GraphQL endpoint: resourceDepartments' operationId: nsk_v1_resources_Departments_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfDepartment' /api/nsk/v1/resources/Departments/{departmentCode}: get: tags: - resources summary: Retrieves the specific department resource. description: 'GraphQL endpoint: resourceDepartment' operationId: nsk_v1_resources_Departments_departmentCode_get parameters: - name: departmentCode in: path required: true description: The unique department code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDepartment' /api/nsk/v1/resources/distributionOptions: get: tags: - resources summary: Retrieves the localizations. description: 'GraphQL endpoint: localizationDistributionOptions' operationId: nsk_v1_resources_distributionOptions_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEnumResource' /api/nsk/v1/resources/DocumentTypes: get: tags: - resources summary: Retrieves the collection of document type resources. description: 'GraphQL endpoint: resourceDocumentTypes' operationId: nsk_v1_resources_DocumentTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfDocumentType' /api/nsk/v1/resources/DocumentTypes/{documentTypeCode}: get: tags: - resources summary: Retrieves the specific document type resource. description: 'GraphQL endpoint: resourceDocumentType' operationId: nsk_v1_resources_DocumentTypes_documentTypeCode_get parameters: - name: documentTypeCode in: path required: true description: The unique document type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDocumentType' /api/nsk/v1/resources/Domains: get: tags: - resources summary: Retrieves the collection of domain resources. description: 'GraphQL endpoint: resourceDomains' operationId: nsk_v1_resources_Domains_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Domains not found: description: Response when there are no existing domains. value: data: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Matching ETag: description: Response when an ETag is provided and the cached data still matches. value: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfDomain' examples: Retrieve domains response: description: Example response for successfully retrieving the configured domains in the system. value: data: - domainCode: DEF name: Default Domain passwordNeverExpires: true minimumPasswordAge: 15 maximumPasswordAge: 90 maximumFaliedLogons: 3 uniquePasswordCount: null passwordPolicy: policy: ^(?=.*\d)(?=.*[a-z])(?=.*[A-Z])(?!.*[\.,~])(?=.*\W).{8,16}$ description: Password must be at least 8 characters, no more than 16 characters, must include at least one upper case letter, one lower case letter, one numeric digit, and one non-alphanumeric. The password cannot contain a period(.) comma(,) or tilde(~). usernamePolicy: policy: ^(?!.*[\.,~]).{2,64}$ description: Username must be at least 2 characters, no more than 64 characters. The username cannot contain a period(.) comma(,) or tilde(~). allowed: true useNewResetPasswordFlow: true challengeCodeContactMethod: 1 maximumFailedPasswordResets: 6 challengeCodeExpirationMinutes: 15 failedPasswordResetMinutes: 30 - domainCode: EXT name: External Domain passwordNeverExpires: true minimumPasswordAge: 15 maximumPasswordAge: 90 maximumFaliedLogons: 3 uniquePasswordCount: 5 passwordPolicy: policy: ^(?=.*\\d)(?=.*[a-z])(?=.*[A-Z])(?!.*[\\.,~])(?=.*\\W).{8,16}$ description: Password must be at least 8 characters, no more than 16 characters, must include at least one upper case letter, one lower case letter, one numeric digit, and one non-alphanumeric. The password cannot contain a period(.) comma(,) or tilde(~). usernamePolicy: policy: ^.*$ description: Username must be at least 2 characters, no more than 64 characters. The username cannot contain a period(.) comma(,) or tilde(~). allowed: true useNewResetPasswordFlow: false challengeCodeContactMethod: 0 maximumFailedPasswordResets: 6 challengeCodeExpirationMinutes: 15 failedPasswordResetMinutes: 30 /api/nsk/v1/resources/Domains/{domainCode}: get: tags: - resources summary: Retrieves the specific domain resource. description: 'GraphQL endpoint: resourceDomain' operationId: nsk_v1_resources_Domains_domainCode_get parameters: - name: domainCode in: path required: true description: The unique domain code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Domain not found: description: Response when the specified domain does not exist. value: data: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDomain' examples: Retrieve domain response: description: Example response for successfully retrieving a specified configured domain in the system. value: data: domainCode: DEF name: Default Domain passwordNeverExpires: true minimumPasswordAge: 15 maximumPasswordAge: 90 maximumFaliedLogons: 3 uniquePasswordCount: null passwordPolicy: policy: ^(?=.*\d)(?=.*[a-z])(?=.*[A-Z])(?!.*[\.,~])(?=.*\W).{8,16}$ description: Password must be at least 8 characters, no more than 16 characters, must include at least one upper case letter, one lower case letter, one numeric digit, and one non-alphanumeric. The password cannot contain a period(.) comma(,) or tilde(~). usernamePolicy: policy: ^(?!.*[\.,~]).{2,64}$ description: Username must be at least 2 characters, no more than 64 characters. The username cannot contain a period(.) comma(,) or tilde(~). allowed: true useNewResetPasswordFlow: true challengeCodeContactMethod: 1 maximumFailedPasswordResets: 6 challengeCodeExpirationMinutes: 15 failedPasswordResetMinutes: 30 /api/nsk/v1/resources/EmailTypes: get: tags: - resources summary: Retrieves the collection of email type resources. description: 'GraphQL endpoint: resourceEmailTypes' operationId: nsk_v1_resources_EmailTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEmailType' /api/nsk/v1/resources/EmailTypes/{emailTypeCode}: get: tags: - resources summary: Retrieves the specific email type resource. description: 'GraphQL endpoint: resourceEmailType' operationId: nsk_v1_resources_EmailTypes_emailTypeCode_get parameters: - name: emailTypeCode in: path required: true description: The unique email type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfEmailType' /api/nsk/v1/resources/ExternalRates: get: tags: - resources summary: Retrieves the collection of external rate resources. description: 'The external rates cache expiration is configurable as a number of minutes past the hour to expire. This should allow for better alignment with third party external rates providers'' recommendations, which typically state that external rates cache items should expire 5-7 minutes past the hour. This can be configured in the NskSystemOptions.ExternalRatesExpiration. If no value is set, the API will default to five minutes past the hour. If the value "Enable External Currency Conversion" is disabled in SkyPay, external rates won''t be returned by this call. Additionally, there are some edge cases where the cache entry expiration is created at or close to the configured expiration time. In these cases, an additional two minutes will be added to the cache expiration. For example, if the configured external rate cache expiration is for five minutes after the hour, and the current time is 12:04, the expiration will be 12:07 instead of 12:05. This gives the cached item enough time to get set into cache, but will expire quickly in order to refresh according to third party external rates providers'' cache requirements (refresh at 5-7 minutes past the hour). GraphQL endpoint: resourceExternalRates' operationId: nsk_v1_resources_ExternalRates_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfExternalRate' /api/nsk/v1/resources/ExternalRates/{rateId}: get: tags: - resources summary: Retrieves the specific external rate resource. description: 'The external rates cache expiration is configurable as a number of minutes past the hour to expire. This should allow for better alignment with third party external rates providers'' recommendations, which typically state that external rates cache items should expire 5-7 minutes past the hour. This can be configured in the NskSystemOptions.ExternalRatesExpiration. If no value is set, the API will default to five minutes past the hour. If the value "Enable External Currency Conversion" is disabled in SkyPay, external rates won''t be returned by this call. GraphQL endpoint: resourceExternalRate' operationId: nsk_v1_resources_ExternalRates_rateId_get parameters: - name: rateId in: path required: true description: The unique rate ID. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfExternalRate' /api/nsk/v1/resources/ExternalSystems: get: tags: - resources summary: Retrieves the collection of external system resources. description: 'GraphQL endpoint: resourceExternalSystems' operationId: nsk_v1_resources_ExternalSystems_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfExternalSystem' /api/nsk/v2/resources/externalSystems/{systemCode}: get: tags: - resources summary: Retrieves a single external system resource. description: 'GraphQL endpoint: resourceExternalSystemv2' operationId: nsk_v2_resources_externalSystems_systemCode_get parameters: - name: systemCode in: path required: true description: The unique external system code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfExternalSystem' /api/nsk/v1/resources/fareBasisCodes: get: tags: - resources summary: Retrieves the list of fare basis codes. description: 'GraphQL endpoint: resourceFareBasisCodes' operationId: nsk_v1_resources_fareBasisCodes_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfString' examples: Fare basis response: description: Gets the list of fare basis codes value: - A - A0807 - A2FARE - AAAAFARE /api/nsk/v1/resources/fareDiscounts: get: tags: - resources summary: Retrieves a collection of fare discount resources. description: 'GraphQL endpoint: resourceFareDiscounts' operationId: nsk_v1_resources_fareDiscounts_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareDiscount' /api/nsk/v1/resources/fareDiscounts/{fareDiscountCode}: get: tags: - resources summary: Retrieves a specific fare discount resource. description: 'GraphQL endpoint: resourceFareDiscount' operationId: nsk_v1_resources_fareDiscounts_fareDiscountCode_get parameters: - name: fareDiscountCode in: path required: true description: The unique fare discount code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFareDiscount' /api/nsk/v1/resources/fareSurcharges: get: tags: - resources summary: Retrieves a collection of fare surcharge resources. description: 'GraphQL endpoint: resourceFareSurcharges' operationId: nsk_v1_resources_fareSurcharges_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareSurcharge' /api/nsk/v1/resources/fareSurcharges/{fareSurchargeCode}: get: tags: - resources summary: Retrieves a specific fare surcharge resource. description: 'GraphQL endpoint: resourceFareSurcharge' operationId: nsk_v1_resources_fareSurcharges_fareSurchargeCode_get parameters: - name: fareSurchargeCode in: path required: true description: The unique fare surcharge code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFareSurcharge' /api/nsk/v1/resources/FareTypes: get: tags: - resources summary: Retrieves the collection of fare type resources. description: 'GraphQL endpoint: resourceFareTypes' operationId: nsk_v1_resources_FareTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareType' /api/nsk/v1/resources/FareTypes/{fareTypeCode}: get: tags: - resources summary: Retrieves the specific fare type resource. description: 'GraphQL endpoint: resourceFareType' operationId: nsk_v1_resources_FareTypes_fareTypeCode_get parameters: - name: fareTypeCode in: path required: true description: The unique fare type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFareType' /api/nsk/v1/resources/Fees: get: tags: - resources summary: Retrieves the collection of fee resources. description: 'GraphQL endpoint: resourceFees' operationId: nsk_v1_resources_Fees_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFee' /api/nsk/v1/resources/Fees/{feeCode}: get: tags: - resources summary: Retrieves the specific fee resource. description: 'GraphQL endpoint: resourceFee' operationId: nsk_v1_resources_Fees_feeCode_get parameters: - name: feeCode in: path required: true description: The unique fee code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFee' /api/nsk/v1/resources/fees/{feeCode}/details: get: tags: - resources summary: Gets the fee options. description: 'Note, this endpoint is not cached like other resource endpoints. The NSK enumeration "TSI.GroundTimeBeforeDepartureFromConnectionWithin" is synonymous with "TravelSegmentIndicator.DepartureWithinStopoverTime". The NSK enumeration "TSI.GroundTimeBeforeDepartureFromConnectionExceeds" is synonymous with "TravelSegmentIndicator.DepartureExceedsStopoverTime". GraphQL endpoint: feeDetails' operationId: nsk_v1_resources_fees_feeCode_details_get parameters: - name: feeCode in: path required: true description: The unique fee code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFeeDetail' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/resources/genders: get: tags: - resources summary: Retrieves the localizations. description: 'GraphQL endpoint: localizationGender' operationId: nsk_v1_resources_genders_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEnumResource' /api/nsk/v1/resources/HotCardReasons: get: tags: - resources summary: Retrieves the collection of hot card reason resources. description: 'GraphQL endpoint: resourceHotCardReasons' operationId: nsk_v1_resources_HotCardReasons_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfHotCardReason' /api/nsk/v1/resources/HotCardReasons/{hotCardReasonCode}: get: tags: - resources summary: Retrieves the specific hot card reason resource. description: 'GraphQL endpoint: resourceHotCardReason' operationId: nsk_v1_resources_HotCardReasons_hotCardReasonCode_get parameters: - name: hotCardReasonCode in: path required: true description: The unique hot card reason. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfHotCardReason' /api/nsk/v1/resources/IssuanceReasons: get: tags: - resources summary: Retrieves the collection of issuance reason resources. description: 'GraphQL endpoint: resourceIssuanceReasons' operationId: nsk_v1_resources_IssuanceReasons_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfIssuanceReason' /api/nsk/v1/resources/IssuanceReasons/{issuanceReasonCode}: get: tags: - resources summary: Retrieves the specific issuance reason resource. description: 'GraphQL endpoint: resourceIssuanceReason' operationId: nsk_v1_resources_IssuanceReasons_issuanceReasonCode_get parameters: - name: issuanceReasonCode in: path required: true description: The unique issuance reason code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIssuanceReason' /api/nsk/v1/resources/Locations: get: tags: - resources summary: Retrieves the collection of location resources. description: 'GraphQL endpoint: resourceLocations' operationId: nsk_v1_resources_Locations_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfLocation' /api/nsk/v1/resources/Locations/{locationCode}: get: tags: - resources summary: Retrieves the specific location resource. description: 'GraphQL endpoint: resourceLocation' operationId: nsk_v1_resources_Locations_locationCode_get parameters: - name: locationCode in: path required: true description: The code for the desired location resource. schema: type: string x-position: 1 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfLocation' /api/nsk/v2/resources/macs: get: tags: - resources summary: Retrieves the collection of mac resources. description: 'GraphQL endpoint: resourceMacsv2' operationId: nsk_v2_resources_macs_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfMac' /api/nsk/v1/resources/Macs/{macCode}: get: tags: - resources summary: Retrieves the specific mac resource. description: 'GraphQL endpoint: resourceMac' operationId: nsk_v1_resources_Macs_macCode_get parameters: - name: macCode in: path required: true description: The unique mac code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMac' /api/nsk/v1/resources/marketRoutes: get: tags: - resources summary: Retrieves the collection of market route resources. description: 'GraphQL endpoint: resourceMarketRoutes' operationId: nsk_v1_resources_marketRoutes_get parameters: - name: DepartureStation in: query description: "Gets or sets the departure station for this request.\n \ \ " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 1 - name: ArrivalStation in: query description: "Gets or sets the arrival station for this request.\n \ \ " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Matching ETag: description: Response when an ETag is provided and the cached data still matches. No Market Routes are returned regardless of the station filters specified. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Departure Station Length Error: description: Example error when departure station is an incorrect length. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: MarketRoutesQuery.DepartureStation:StringLengthAttribute message: MarketRoutesQuery.DepartureStation:StringLengthAttribute type: Validation details: validation: StringLengthAttribute model: MarketRoutesQuery member: DepartureStation rawMessage: The field MarketRoutesQuery must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Arrival Station Length Error: description: Example error when arrival station is an incorrect length. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: MarketRoutesQuery.ArrivalStation:StringLengthAttribute message: MarketRoutesQuery.ArrivalStation:StringLengthAttribute type: Validation details: validation: StringLengthAttribute model: MarketRoutesQuery member: ArrivalStation rawMessage: The field MarketRoutesQuery must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfMarketRoute' examples: Default without DepartureStation or ArrivalStation filters: description: Response when neither DepartureStation or ArrivalStation are specified. All Market Routes are returned. value: data: - arrivalStation: BOS departureStation: ATL connectionMarketSegments: - departureStation: ATL arrivalStation: BOS segmentNumber: 1 - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: ATL segmentNumber: 2 - departureStation: ATL arrivalStation: JFK segmentNumber: 3 - arrivalStation: JFK departureStation: DEN connectionMarketSegments: - departureStation: DEN arrivalStation: JFK segmentNumber: 1 - arrivalStation: BOS departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: BOS segmentNumber: 2 - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: JFK segmentNumber: 2 DepartureStation filter specified: description: Response when DepartureStation filter specified but not ArrivalStation. Market Routes with the specified DepartureStation are returned. value: data: - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: ATL segmentNumber: 2 - departureStation: ATL arrivalStation: JFK segmentNumber: 3 - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: JFK segmentNumber: 2 ArrivalStation filter specified: description: Response when ArrivalStation filter specified but not DepartureStation. Market Routes with the specified ArrivalStation are returned. value: data: - arrivalStation: BOS departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: BOS segmentNumber: 2 - arrivalStation: BOS departureStation: ATL connectionMarketSegments: - departureStation: ATL arrivalStation: BOS segmentNumber: 1 DepartureStation and ArrivalStation filters specified: description: Response when both DepartureStation and ArrivalStation filters are specified. Only Market Routes with the specified DepartureStation and ArrivalStation are returned. value: data: - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: ATL segmentNumber: 2 - departureStation: ATL arrivalStation: JFK segmentNumber: 3 - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: JFK segmentNumber: 2 /api/nsk/v2/resources/markets: get: tags: - resources summary: Retrieves the collection of market resources. description: 'GraphQL endpoint: resourceMarketsv2' operationId: nsk_v2_resources_markets_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfMarketv2' /api/nsk/v2/resources/markets/{locationCode}: get: tags: - resources summary: Retrieves a specific market resource. description: 'GraphQL endpoint: resourceMarketByLocationv2' operationId: nsk_v2_resources_markets_locationCode_get parameters: - name: locationCode in: path required: true description: The unique location code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfMarketv2' /api/nsk/v2/resources/markets/{locationCode}/{travelLocationCode}: get: tags: - resources summary: Retrieves the resource. description: 'GraphQL endpoint: resourceMarketv2' operationId: nsk_v2_resources_markets_locationCode_travelLocationCode_get parameters: - name: locationCode in: path required: true description: The code for the desired location resource. schema: type: string x-position: 1 - name: travelLocationCode in: path required: true description: The code for the desired travel location resource. schema: type: string x-position: 2 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMarketv2' /api/nsk/v1/resources/MessageTypes: get: tags: - resources summary: Retrieves the collection of message type resources. description: 'GraphQL endpoint: resourceMessageTypes' operationId: nsk_v1_resources_MessageTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfMessageType' /api/nsk/v1/resources/MessageTypes/{messageTypeCode}: get: tags: - resources summary: Retrieves the specific message type resource. description: 'GraphQL endpoint: resourceMessageType' operationId: nsk_v1_resources_MessageTypes_messageTypeCode_get parameters: - name: messageTypeCode in: path required: true description: The unique message type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMessageType' /api/nsk/v1/resources/nonBinaryGenders: get: tags: - resources summary: Retrieves the collection of non-binary genders configured in the system. description: 'If the `Enable Gender Neutral` settings is unchecked, only the `M (Male)` and `F (Female)` are considered as valid non-binary genders for passengers. GraphQL endpoint: resourceNonBinaryGenders' operationId: nsk_v1_resources_nonBinaryGenders_get parameters: - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 1 - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNonBinaryGender' examples: Retrieve non-binary genders response: description: Example response for successfully retrieving the configured non-binary genders in the system. value: data: - code: F name: Female inActive: false - code: M name: Male inActive: false - code: U name: Undisclosed inActive: false - code: X name: Unspecified inActive: false /api/nsk/v1/resources/nonBinaryGenders/{code}: get: tags: - resources summary: Retrieves the specified non-binary gender. description: 'GraphQL endpoint: resourceNonBinaryGender' operationId: nsk_v1_resources_nonBinaryGenders_code_get parameters: - name: code in: path required: true description: The unique non-binary gender code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNonBinaryGender' /api/nsk/v1/resources/organizationStatuses: get: tags: - resources summary: Retrieves the localizations. description: 'GraphQL endpoint: localizationOrganizationStatus' operationId: nsk_v1_resources_organizationStatuses_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEnumResource' /api/nsk/v1/resources/PassengerDiscounts: get: tags: - resources summary: Retrieves the collection of passenger discount resources. description: 'GraphQL endpoint: resourcePassengerDiscounts' operationId: nsk_v1_resources_PassengerDiscounts_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerDiscount' /api/nsk/v1/resources/PassengerDiscounts/{passengerDiscountCode}: get: tags: - resources summary: Retrieves the specific passenger discount resource. description: 'GraphQL endpoint: resourcePassengerDiscount' operationId: nsk_v1_resources_PassengerDiscounts_passengerDiscountCode_get parameters: - name: passengerDiscountCode in: path required: true description: The unique passenger discount code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerDiscount' /api/nsk/v1/resources/PassengerTypes: get: tags: - resources summary: Retrieves the collection of role-based passenger type resources. description: 'GraphQL endpoint: resourcePassengerTypes' operationId: nsk_v1_resources_PassengerTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Culture Code Not Configured: description: The provided culture code in the request is not configured in the resources. For valid culture codes, see GET /api/nsk/v1/resources/cultures value: errors: - id: null code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''asdf'' is out of range for ''ResourceQueryBase.CultureCode''.\nExpected values: (en-US,ar-AE,ar-BH,ar-IQ,ar-KW,ar-QA,ar-SA,ar-SY,ca-ES,de-CH,de-DE,de-LI,en-AU,en-CA,en-GB,en-IE,en-NZ,en-PH,en-TT,en-ZA,en-ZW,es-ES,es-GT,es-MX,fr-CA,fr-FR,hi-IN,hu-HU,id-ID,it-IT,ja-JP,ko-KR,ms,ms-MY,nb-NO,pt-BR,ru-RU,sw,sw-KE,th-TH,vi-VN,zh-CN,zh-SG,zh-TW)' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerType' examples: Retrieve Passenger Types Response: description: Example response for successfully retrieving the passenger types in the system. value: data: - nonAdult: false passengerTypeCode: ADT name: Adult allowed: true inActive: false typeIndicator: 0 minimumAge: 18 maximumAge: 65 - nonAdult: false passengerTypeCode: SNR name: Senior allowed: true inActive: false typeIndicator: 0 minimumAge: 60 maximumAge: 150 Passenger Types Not Found: description: Example response when there are no existing passenger types. value: data: [] /api/nsk/v1/resources/PassengerTypes/{passengerTypeCode}: get: tags: - resources summary: Retrieves the specific role-based passenger type resource. description: 'GraphQL endpoint: resourcePassengerType' operationId: nsk_v1_resources_PassengerTypes_passengerTypeCode_get parameters: - name: passengerTypeCode in: path required: true description: The unique passenger type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Type Not Found: description: Example response when the specified passenger type does not exist. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Culture Code Not Configured: description: The provided culture code in the request is not configured in the resources. For valid culture codes, see GET /api/nsk/v1/resources/cultures value: errors: - id: null code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''asdf'' is out of range for ''ResourceQueryBase.CultureCode''.\nExpected values: (en-US,ar-AE,ar-BH,ar-IQ,ar-KW,ar-QA,ar-SA,ar-SY,ca-ES,de-CH,de-DE,de-LI,en-AU,en-CA,en-GB,en-IE,en-NZ,en-PH,en-TT,en-ZA,en-ZW,es-ES,es-GT,es-MX,fr-CA,fr-FR,hi-IN,hu-HU,id-ID,it-IT,ja-JP,ko-KR,ms,ms-MY,nb-NO,pt-BR,ru-RU,sw,sw-KE,th-TH,vi-VN,zh-CN,zh-SG,zh-TW)' 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 '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerType' examples: Retrieve Passenger Type Response: description: Example response for successfully retrieving a specified configured passenger type in the system. value: data: nonAdult: false passengerTypeCode: ADT name: Adult allowed: true inActive: false typeIndicator: 0 minimumAge: 18 maximumAge: 65 /api/nsk/v1/resources/PaymentMethods: get: tags: - resources summary: Retrieves the collection of payment method resources. description: 'GraphQL endpoint: resourcePaymentMethods' operationId: nsk_v1_resources_PaymentMethods_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 - name: currencyCode in: query description: The currency code. schema: type: string nullable: true x-position: 6 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPaymentMethod' /api/nsk/v2/resources/paymentMethods/{paymentMethodCode}: get: tags: - resources summary: 'Retrieves the specific payment method resources that match the payment method code. If the payment method type is set, returns a list with a single payment method that matches both the payment method code and the payment method type.' description: 'A payment method is considered unique based on the payment method code and the payment method type. GraphQL endpoint: resourcePaymentMethodv2' operationId: nsk_v2_resources_paymentMethods_paymentMethodCode_get parameters: - name: paymentMethodCode in: path required: true description: The unique payment method code. schema: type: string x-position: 1 - name: PaymentMethodType in: query description: "The payment method type.\n \nEnumeration values:\ \ 0 = ExternalAccount, 1 = PrePaid, 2 = AgencyAccount, 3 = CustomerAccount,\ \ 4 = Voucher, 5 = Loyalty" schema: nullable: true $ref: '#/components/schemas/PaymentMethodType' x-position: 2 - name: CurrencyCode in: query description: "The payment method code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 3 - name: CultureCode in: query description: "The payment method code.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPaymentMethod' /api/nsk/v1/resources/PaymentMethods/{paymentMethodCode}: get: tags: - resources summary: Retrieves the specific payment method resource. description: 'GraphQL endpoint: resourcePaymentMethod' operationId: nsk_v1_resources_PaymentMethods_paymentMethodCode_get parameters: - name: paymentMethodCode in: path required: true description: The unique payment method code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 - name: currencyCode in: query description: The specific currency code. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentMethod' deprecated: true /api/nsk/v1/resources/PersonInformationTypes: get: tags: - resources summary: Retrieves the collection of person information type resources. description: 'GraphQL endpoint: resourcePersonInfoTypes' operationId: nsk_v1_resources_PersonInformationTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonInformationType' /api/nsk/v1/resources/PersonInformationTypes/{personInformationTypeCode}: get: tags: - resources summary: Retrieves the specific person information type resource. description: 'GraphQL endpoint: resourcePersonInfoType' operationId: nsk_v1_resources_PersonInformationTypes_personInformationTypeCode_get parameters: - name: personInformationTypeCode in: path required: true description: "The unique person information type code. Please note that this\ \ should be a char\nand not a string.\n " schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonInformationType' /api/nsk/v1/resources/PhoneTypes: get: tags: - resources summary: Retrieves the collection of phone number type resources. description: 'GraphQL endpoint: resourcePhoneTypes' operationId: nsk_v1_resources_PhoneTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPhoneType' /api/nsk/v1/resources/PhoneTypes/{phoneTypeCode}: get: tags: - resources summary: Retrieves the specific phone number type resource. description: 'GraphQL endpoint: resourcePhoneType' operationId: nsk_v1_resources_PhoneTypes_phoneTypeCode_get parameters: - name: phoneTypeCode in: path required: true description: The unique phone type. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPhoneType' /api/nsk/v1/resources/postalCodes: get: tags: - resources summary: Retrieves the collection of postal codes resources. description: 'GraphQL endpoint: resourcePostalCodes' operationId: nsk_v1_resources_postalCodes_get parameters: - name: CountryCode in: query description: "The country code.\n " schema: type: string maxLength: 2 minLength: 0 nullable: true x-position: 1 - name: ProvinceStateCode in: query description: "The province state code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: City in: query description: "The city.\n " schema: type: string maxLength: 32 minLength: 0 nullable: true x-position: 3 - name: PageSize in: query description: "The default page size.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 - name: LastPageKey in: query description: "Used to specify the last item of the page of the last set of\ \ records retrieved\nwhen paging was performed. This is optional.\n \ \ " schema: type: string nullable: true x-position: 5 - name: PostalCode in: query description: "The postal code.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 6 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfResourcePostalCodeResponse' /api/nsk/v1/resources/postalCodes/{postalCode}: get: tags: - resources summary: Retrieves the postal code resource. description: 'GraphQL endpoint: resourcePostalCode' operationId: nsk_v1_resources_postalCodes_postalCode_get parameters: - name: postalCode in: path required: true description: The unique postal code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPostalCode' /api/nsk/v1/resources/printers: get: tags: - resources summary: Retrieves a collection of printer resources. description: 'GraphQL endpoint: resourcePrinters' operationId: nsk_v1_resources_printers_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPrinter' /api/nsk/v1/resources/printers/{printerCode}: get: tags: - resources summary: Retrieves a specific printer resource. description: 'GraphQL endpoint: resourcePrinter' operationId: nsk_v1_resources_printers_printerCode_get parameters: - name: printerCode in: path required: true description: The unique printer code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPrinter' /api/nsk/v1/resources/ProductClasses: get: tags: - resources summary: Retrieves the collection of product class resources. description: 'GraphQL endpoint: resourceProductClasses' operationId: nsk_v1_resources_ProductClasses_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfProductClass' /api/nsk/v1/resources/ProductClasses/{productClassCode}: get: tags: - resources summary: Retrieves the specific product class resource. description: 'GraphQL endpoint: resourceProductClass' operationId: nsk_v1_resources_ProductClasses_productClassCode_get parameters: - name: productClassCode in: path required: true description: The code identifying the specific product class to retrieve. schema: type: string x-position: 1 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProductClass' /api/nsk/v1/resources/PromotionSettingTypes: get: tags: - resources summary: Retrieves the collection of promotion setting type resources. description: 'GraphQL endpoint: resourcePromotionSettingTypes' operationId: nsk_v1_resources_PromotionSettingTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPromotionSettingType' /api/nsk/v1/resources/PromotionSettingTypes/{promotionSettingsTypeCode}: get: tags: - resources summary: Retrieves the specific promotion setting type resource. description: 'GraphQL endpoint: resourcePromotionSettingType' operationId: nsk_v1_resources_PromotionSettingTypes_promotionSettingsTypeCode_get parameters: - name: promotionSettingsTypeCode in: path required: true description: The code identifying the promotion settings type resource to retrieve schema: type: string x-position: 1 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPromotionSettingType' /api/nsk/v1/resources/ProvinceStates: get: tags: - resources summary: Retrieves the collection of province state resources. description: 'GraphQL endpoint: resourceProvinceStates' operationId: nsk_v1_resources_ProvinceStates_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfProvinceState' /api/nsk/v1/resources/ProvinceStates/{provinceStateCode}: get: tags: - resources summary: Retrieves the specific province state resource. description: 'GraphQL endpoint: resourceProvinceState' operationId: nsk_v1_resources_ProvinceStates_provinceStateCode_get parameters: - name: provinceStateCode in: path required: true description: The unique province state code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProvinceState' /api/nsk/v1/resources/queue/categories: get: tags: - resources summary: Gets a response with a list of QueueCategories that match the given parameters. description: 'GraphQL endpoint: queueCategoryResource' operationId: nsk_v1_resources_queue_categories_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfQueueCategory' /api/nsk/v1/resources/queue/categories/{queueCategoryCode}: get: tags: - resources summary: Gets a response with a single QueueCategory that match the given parameters. description: 'GraphQL endpoint: queueCategoryResourceById' operationId: nsk_v1_resources_queue_categories_queueCategoryCode_get parameters: - name: queueCategoryCode in: path required: true description: "Queue Category Code being requested. Please note that this should\ \ be a char and not a\nstring.\n " schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: '[Optional] The culture code for the resources.' schema: type: string nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfQueueCategory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/resources/reminderTimes: get: tags: - resources summary: 'Retrieves the collection of reminder time resource that contains valid times for all passenger travel notification timed events.' description: 'GraphQL endpoint: resourceReminderTimes' operationId: nsk_v1_resources_reminderTimes_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfReminderTime' /api/nsk/v1/resources/reminderTimes/{timedEventType}: get: tags: - resources summary: 'Retrieves a specific reminder time resource that contains valid times for a passenger travel notification timed event.' description: 'GraphQL endpoint: resourceReminderTime' operationId: nsk_v1_resources_reminderTimes_timedEventType_get parameters: - name: timedEventType in: path required: true description: "The timed event type. \nEnumeration values: 0 = Departure, 1\ \ = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfReminderTime' /api/nsk/v1/resources/roles: post: tags: - resources summary: BETA - Creates a new role. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. GraphQL endpoint: resourceRoleAdd' operationId: nsk_v1_resources_roles_post requestBody: x-name: request description: The create role request. content: application/json: schema: $ref: '#/components/schemas/CreateRoleRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/resources/roles: get: tags: - resources summary: Retrieves the role resources. description: 'GraphQL endpoint: resourceRolesv2' operationId: nsk_v2_resources_roles_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfRolev2' /api/nsk/v1/resources/roles/{roleCode}: delete: tags: - resources summary: BETA - Delete a role. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. GraphQL endpoint: resourceRoleDelete' operationId: nsk_v1_resources_roles_roleCode_delete parameters: - name: roleCode in: path required: true description: The role code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/resources/roles/{roleCode}: get: tags: - resources summary: Retrieves a single role resource. description: 'GraphQL endpoint: resourceRolev2' operationId: nsk_v2_resources_roles_roleCode_get parameters: - name: roleCode in: path required: true description: The unique role code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRolev2' /api/nsk/v1/resources/roles/{roleCode}/settings: get: tags: - resources summary: Retrieves the resource. description: 'GraphQL endpoint: resourceRoleSettings' operationId: nsk_v1_resources_roles_roleCode_settings_get parameters: - name: roleCode in: path required: true description: The unique role code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfRoleSettingv2' /api/nsk/v1/resources/RoleSettingTypes: get: tags: - resources summary: Retrieves the collection of role setting resources. description: 'GraphQL endpoint: resourceRoleSettingTypes' operationId: nsk_v1_resources_RoleSettingTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfRoleSettingType' /api/nsk/v1/resources/RoleSettingTypes/{roleSettingTypeCode}: get: tags: - resources summary: Retrieves the specific role setting resource. description: 'GraphQL endpoint: resourceRoleSettingType' operationId: nsk_v1_resources_RoleSettingTypes_roleSettingTypeCode_get parameters: - name: roleSettingTypeCode in: path required: true description: The unique role setting type code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRoleSettingType' /api/nsk/v1/resources/searchTypes: get: tags: - resources summary: Retrieves the localizations. description: 'GraphQL endpoint: localizationSearchType' operationId: nsk_v1_resources_searchTypes_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEnumResource' /api/nsk/v2/resources/seatPropertyTypes: get: tags: - resources summary: Retrieves a list of seat property types. description: 'GraphQL endpoint: resourceSeatPropertyTypes' operationId: nsk_v2_resources_seatPropertyTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSeatPropertyType' /api/nsk/v2/resources/seatPropertyTypes/{seatPropertyTypeCode}: get: tags: - resources summary: Retrieves a single seat property type resource. description: 'GraphQL endpoint: resourceSeatPropertyTypev2' operationId: nsk_v2_resources_seatPropertyTypes_seatPropertyTypeCode_get parameters: - name: seatPropertyTypeCode in: path required: true description: The unique seat property type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSeatPropertyType' /api/nsk/v1/resources/settings: post: tags: - resources summary: Retrieves a resource setting and its related information. description: 'This is a post to easily allow special path characters. See /resources/settings/data to avoid manually parsing the data. GraphQL endpoint: resourceSettingCategory' operationId: nsk_v1_resources_settings_post parameters: - name: eTag in: query description: ETag for caching. schema: type: string nullable: true x-position: 2 requestBody: x-name: request description: The resource settings request. content: application/json: schema: $ref: '#/components/schemas/SettingsCategoryRequest' required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfResourceCategoryItem' /api/nsk/v1/resources/settings/data: post: tags: - resources summary: Retrieves resource setting data based on the accept content type. description: 'This is a post to easily allow special path characters. GraphQL endpoint: resourceSettingCategoryJson' operationId: nsk_v1_resources_settings_data_post parameters: - name: eTag in: query description: ETag for caching. schema: type: string nullable: true x-position: 2 requestBody: x-name: request description: The resource settings request. content: application/json: schema: $ref: '#/components/schemas/SettingsCategoryRequest' required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '415': description: Unsupported media type. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: type: string /api/nsk/v1/resources/ShoppingAttributeGroups: get: tags: - resources summary: Retrieves the collection of shopping attribute group resources. description: 'GraphQL endpoint: resourceShoppingAttributeGroups' operationId: nsk_v1_resources_ShoppingAttributeGroups_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfShoppingAttributeGroup' /api/nsk/v1/resources/ShoppingAttributeGroups/{shoppingAttributeGroupCode}: get: tags: - resources summary: Retrieves the specific shopping attribute group resource. description: 'GraphQL endpoint: resourceShoppingAttributeGroup' operationId: nsk_v1_resources_ShoppingAttributeGroups_shoppingAttributeGroupCode_get parameters: - name: shoppingAttributeGroupCode in: path required: true description: The unique shopping attribute group code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfShoppingAttributeGroup' /api/nsk/v1/resources/ShoppingAttributes: get: tags: - resources summary: Retrieves the collection of shopping attribute resources. description: 'GraphQL endpoint: resourceShoppingAttributes' operationId: nsk_v1_resources_ShoppingAttributes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfShoppingAttribute' /api/nsk/v1/resources/ShoppingAttributes/{shoppingAttributeCode}: get: tags: - resources summary: Retrieves the specific shopping attribute resource. description: 'GraphQL endpoint: resourceShoppingAttribute' operationId: nsk_v1_resources_ShoppingAttributes_shoppingAttributeCode_get parameters: - name: shoppingAttributeCode in: path required: true description: The unique shopping attribute code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfShoppingAttribute' /api/nsk/v1/resources/singleSignOnProvider: get: tags: - resources summary: Retrieves a list of available single sign on providers. description: 'GraphQL endpoint: singleSignOnProviders' operationId: nsk_v1_resources_singleSignOnProvider_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSingleSignOnProvider' /api/nsk/v1/resources/singleSignOnProvider/{providerName}: get: tags: - resources summary: Retrieves a specific single sign on provider. description: 'GraphQL endpoint: singleSignOnProviderByName' operationId: nsk_v1_resources_singleSignOnProvider_providerName_get parameters: - name: providerName in: path required: true description: The single sign on provider name. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSingleSignOnProvider' /api/nsk/v1/resources/SsrGroups: get: tags: - resources summary: Retrieves the collection of ssr group resources. description: 'GraphQL endpoint: resourceSsrGroups' operationId: nsk_v1_resources_SsrGroups_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsrGroup' /api/nsk/v1/resources/SsrGroups/{ssrGroupCode}: get: tags: - resources summary: Retrieves the specific ssr group resource. description: 'GraphQL endpoint: resourceSsrGroup' operationId: nsk_v1_resources_SsrGroups_ssrGroupCode_get parameters: - name: ssrGroupCode in: path required: true description: The SSR Group Code wanted. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSsrGroup' /api/nsk/v1/resources/SsrNests: get: tags: - resources summary: Retrieves the collection of ssr nest resources. description: 'GraphQL endpoint: resourceSsrNests' operationId: nsk_v1_resources_SsrNests_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsrNest' /api/nsk/v1/resources/SsrNests/{ssrNestCode}: get: tags: - resources summary: Retrieves the specific ssr nest resource. description: 'GraphQL endpoint: resourceSsrNest' operationId: nsk_v1_resources_SsrNests_ssrNestCode_get parameters: - name: ssrNestCode in: path required: true description: The unique ssr nest code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSsrNest' /api/nsk/v1/resources/SsrRestrictionResults: get: tags: - resources summary: Retrieves the collection of ssr restriction result resources. description: 'GraphQL endpoint: resourceSsrRestrictionResults' operationId: nsk_v1_resources_SsrRestrictionResults_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsrRestrictionResult' /api/nsk/v1/resources/SsrRestrictionResults/{ssrRestrictionResultCode}: get: tags: - resources summary: Retrieves the specific ssr restriction result. resource. description: 'GraphQL endpoint: resourceSsrRestrictionResult' operationId: nsk_v1_resources_SsrRestrictionResults_ssrRestrictionResultCode_get parameters: - name: ssrRestrictionResultCode in: path required: true description: The unique ssr restriction result code. schema: type: string x-position: 1 - name: cultureCode in: query description: The unique culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSsrRestrictionResult' /api/nsk/v1/resources/Ssrs: get: tags: - resources summary: Retrieves the collection of ssr resources. description: 'GraphQL endpoint: resourceSsrs' operationId: nsk_v1_resources_Ssrs_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsr' /api/nsk/v1/resources/Ssrs/{ssrCode}: get: tags: - resources summary: Retrieves the specific ssr resource. description: 'GraphQL endpoint: resourceSsr' operationId: nsk_v1_resources_Ssrs_ssrCode_get parameters: - name: ssrCode in: path required: true description: The unique ssr code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSsr' /api/nsk/v1/resources/StandByPriorities: get: tags: - resources summary: Retrieves the collection of standby priority resources. description: 'GraphQL endpoint: resourceStandByPriorities' operationId: nsk_v1_resources_StandByPriorities_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfStandByPriority' /api/nsk/v1/resources/StandByPriorities/{standByPriorityCode}: get: tags: - resources summary: Retrieves the specific standby priority resource. description: 'GraphQL endpoint: resourceStandByPriority' operationId: nsk_v1_resources_StandByPriorities_standByPriorityCode_get parameters: - name: standByPriorityCode in: path required: true description: The unique standby priority code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfStandByPriority' /api/nsk/v1/resources/StationCategories: get: tags: - resources summary: Retrieves the collection of station category resources. description: 'GraphQL endpoint: resourceStationCategories' operationId: nsk_v1_resources_StationCategories_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfStationCategory' /api/nsk/v1/resources/StationCategories/{stationCategoryCode}: get: tags: - resources summary: Retrieves the specific station category resource. description: 'GraphQL endpoint: resourceStationCategory' operationId: nsk_v1_resources_StationCategories_stationCategoryCode_get parameters: - name: stationCategoryCode in: path required: true description: "The unique station category code. Please note that this should\ \ be a char and not a\nstring.\n " schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfStationCategory' /api/nsk/beta/resources/stations: post: tags: - resources summary: BETA - Creates a new station. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. This endpoint is also currently having some performance issues, expect delays when a request is submitted. The performance issues will be resolved prior to taking this endpoint out of beta. GraphQL endpoint: resourceStationAddBeta' operationId: nsk_beta_resources_stations_post requestBody: x-name: request description: The create station request. content: application/json: schema: $ref: '#/components/schemas/CreateStationRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/resources/Stations: get: tags: - resources summary: Retrieves the collection of station resources. description: 'GraphQL endpoint: resourceStations' operationId: nsk_v1_resources_Stations_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfStation' /api/nsk/beta/resources/stations/{stationCode}: put: tags: - resources summary: BETA - Updates a station. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. This endpoint is also currently having some performance issues, expect delays when a request is submitted. The performance issues will be resolved prior to taking this endpoint out of beta. GraphQL endpoint: resourceStationSetBeta' operationId: nsk_beta_resources_stations_stationCode_put parameters: - name: stationCode in: path required: true description: The unique identifier of a station. schema: type: string x-position: 1 requestBody: x-name: request description: The update station request. content: application/json: schema: $ref: '#/components/schemas/UpdateStationRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - resources summary: BETA - Modifies a station. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. This endpoint is also currently having some performance issues, expect delays when a request is submitted. The performance issues will be resolved prior to taking this endpoint out of beta. GraphQL endpoint: resourceStationModifyBeta' operationId: nsk_beta_resources_stations_stationCode_patch parameters: - name: stationCode in: path required: true description: The unique identifier of a station. schema: type: string x-position: 1 requestBody: x-name: request description: The update station request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfUpdateStationRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/resources/Stations/{stationCode}: get: tags: - resources summary: Retrieves the specific station resource. description: 'GraphQL endpoint: resourceStationv2' operationId: nsk_v1_resources_Stations_stationCode_get parameters: - name: stationCode in: path required: true description: The unique station code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfStation' /api/nsk/v1/resources/stations/{stationCode}/details: get: tags: - resources summary: Get the station details. description: 'Note this endpoint is not cached like other resource endpoints. GraphQL endpoint: resourceStationDetails' operationId: nsk_v1_resources_stations_stationCode_details_get parameters: - name: stationCode in: path required: true description: The station code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfStationDetail' /api/nsk/v1/resources/stations/category/{stationCategoryCode}: get: tags: - resources summary: Gets a response with stations filtered by category. description: 'This endpoint is resource intensive until cached. GraphQL endpoint: resourceStationsByCategory' operationId: nsk_v1_resources_stations_category_stationCategoryCode_get parameters: - name: stationCategoryCode in: path required: true description: "The unique station category code. Please note that this should\ \ be a char and not a\nstring.\n " schema: type: string maxLength: 1 x-position: 1 - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 2 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 3 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 4 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 6 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfStation' /api/nsk/v1/resources/Suffixes: get: tags: - resources summary: Retrieves the collection of suffix resources. description: 'GraphQL endpoint: resourceSuffixes' operationId: nsk_v1_resources_Suffixes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSuffix' /api/nsk/v1/resources/Suffixes/{suffixCode}: get: tags: - resources summary: Retrieves the specific suffix resource. description: 'GraphQL endpoint: resourceSuffix' operationId: nsk_v1_resources_Suffixes_suffixCode_get parameters: - name: suffixCode in: path required: true description: The unique suffix code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture for the suffix. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSuffix' /api/dcs/v1/resources/tailNumbers: get: tags: - resources summary: Retrieves the tail number inventory. description: 'GraphQL endpoint: dcsResourceTailNumberInventory' operationId: dcs_v1_resources_tailNumbers_get parameters: - name: eTag in: query description: The resource eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTailNumberInventoryItem' /api/nsk/v1/resources/TimeZones: get: tags: - resources summary: Retrieves the collection of time zone resources. description: 'GraphQL endpoint: resourceTimeZones' operationId: nsk_v1_resources_TimeZones_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTimeZone' /api/nsk/v1/resources/TimeZones/{timeZoneCode}: get: tags: - resources summary: Retrieves the specific time zone resource. description: 'GraphQL endpoint: resourceTimeZonev2' operationId: nsk_v1_resources_TimeZones_timeZoneCode_get parameters: - name: timeZoneCode in: path required: true description: The unique time zone code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTimeZone' /api/nsk/v1/resources/Titles: get: tags: - resources summary: Retrieves the collection of title resources. description: 'GraphQL endpoint: resourceTitles' operationId: nsk_v1_resources_Titles_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTitle' examples: Retrieve titles response: description: Example response for successfully retrieving the configured titles in the system. value: data: - titleKey: MR description: Mr. gender: 1 weightCategory: 1 inActive: false declaredGender: M - titleKey: MS description: Ms. gender: 2 weightCategory: 2 inActive: false declaredGender: F - titleKey: Mx description: Undisclosed gender: 1 weightCategory: 1 inActive: false declaredGender: X - titleKey: Mu description: Unspecified gender: 1 weightCategory: 1 inActive: false declaredGender: U /api/nsk/v1/resources/Titles/{titleKey}: get: tags: - resources summary: Retrieves the specific title resource. description: 'GraphQL endpoint: resourceTitle' operationId: nsk_v1_resources_Titles_titleKey_get parameters: - name: titleKey in: path required: true description: The unique title key. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture for the title. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTitle' /api/nsk/v1/resources/TravelClasses: get: tags: - resources summary: Retrieves the collection of travel class resources. description: 'GraphQL endpoint: resourceTravelClasses' operationId: nsk_v1_resources_TravelClasses_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n \ \ " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned\ \ if etag still matches.\n " schema: type: string nullable: true x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: integer format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTravelClass' /api/nsk/v1/resources/TravelClasses/{travelClassCode}: get: tags: - resources summary: Retrieves the specific travel class resource. description: 'GraphQL endpoint: resourceTravelClass' operationId: nsk_v1_resources_TravelClasses_travelClassCode_get parameters: - name: travelClassCode in: path required: true description: The unique travel class code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTravelClass' /api/nsk/v1/resources/travelerNotifications: get: tags: - resources summary: Retrieves a collection of traveler notification resource. description: 'GraphQL endpoint: resourceTravelerNotifications' operationId: nsk_v1_resources_travelerNotifications_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTravelerNotification' /api/nsk/v1/resources/travelerNotifications/{notificationTypeCode}: get: tags: - resources summary: Retrieves the specified traveler notification resource. description: 'GraphQL endpoint: resourceTravelerNotification' operationId: nsk_v1_resources_travelerNotifications_notificationTypeCode_get parameters: - name: notificationTypeCode in: path required: true description: Traveler notification type. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTravelerNotification' /api/nsk/v1/resources/travelerNotifications/deliveryMethods: get: tags: - resources summary: Retrieves the traveler notification delivery methods filtered by program code and level. description: 'This endpoint will return the allowed traveler notification delivery methods based on the program code and level. Any delivery methods that have a required program and level where the passed in values do not meet that level or above will be removed. If the customer is not enrolled in the default loyalty program, leave the program code and level null and the delivery methods will be filtered appropriately. GraphQL endpoint: resourceTravelerNotificationDeliveryMethods' operationId: nsk_v1_resources_travelerNotifications_deliveryMethods_get parameters: - name: programCode in: query description: The customer's default loyalty program code. schema: type: string nullable: true x-position: 1 - name: programLevel in: query description: The customer's program level of their default loyalty program. schema: type: string nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTravelerNotificationDeliveryMethod' /api/nsk/v1/resources/travelerNotifications/deliveryMethodSettings: get: tags: - resources summary: Retrieves the notification delivery method settings resource. description: 'Contains information about the SMS, PUSH, and EMAIL notification delivery methods and their maximum number of allowed notifications. GraphQL endpoint: resourceNotificationDeliveryMethodSettings' operationId: nsk_v1_resources_travelerNotifications_deliveryMethodSettings_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationDeliveryMethod' /api/nsk/v1/resources/zones/{zoneCode}/subZones: get: tags: - resources summary: Retrieves the collection of subzones. description: 'This endpoint does not cache the resulting subzone resources. GraphQL endpoint: resourceSubZonesv2' operationId: nsk_v1_resources_zones_zoneCode_subZones_get parameters: - name: zoneCode in: path required: true description: The unique code of the zone to which the subzones belong. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSubZonev2' /api/nsk/v1/resources/zones/{zoneCode}/subZones/{subZoneCode}: get: tags: - resources summary: Retrieves the specific subzone. description: 'This endpoint does not retrieve the subzone resource from the cache. GraphQL endpoint: resourceSubZonev2' operationId: nsk_v1_resources_zones_zoneCode_subZones_subZoneCode_get parameters: - name: zoneCode in: path required: true description: The unique code of the zone to which the subzones belong. schema: type: string x-position: 1 - name: subZoneCode in: path required: true description: The unique subzone code. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSubZonev2' /api/nsk/v4/seatmaps/{journeyKey}: get: tags: - seatmaps summary: Gets the list of seat maps for a specified journey. description: 'GraphQL endpoint: seatMapv4' operationId: nsk_v4_seatmaps_journeyKey_get parameters: - name: journeyKey in: path required: true description: The Journey Key. schema: type: string x-position: 1 - name: IncludePropertyLookup in: query description: "Flag indicating to include seat property lookup on the response.\n\ \ " schema: type: boolean nullable: true x-position: 2 - name: CultureCode in: query description: "The desired culture code.\n " schema: type: string nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSeatMapStatelessAvailability' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/seatmaps/{legKey}: get: tags: - seatmaps summary: Gets the seat maps for a specified leg. description: 'GraphQL endpoint: seatMapByLegKey' operationId: nsk_v1_seatmaps_legKey_get parameters: - name: legKey in: path required: true description: The leg Key. schema: type: string x-position: 1 - name: IncludePropertyLookup in: query description: "Flag indicating to include seat property lookup on the response.\n\ \ " schema: type: boolean nullable: true x-position: 2 - name: CultureCode in: query description: "The desired culture code.\n " schema: type: string nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSeatMapStatelessAvailability' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v2/seats/block: post: tags: - seats summary: Blocks seats on a specific piece of equipment. description: 'A blocked seat cannot be associated with/assigned to a passenger. The change can be verified on a unit''s availability on a seat map. GraphQL endpoint: seatsBlockv2' operationId: dcs_v2_seats_block_post requestBody: x-name: request description: The seat block request. content: application/json: schema: $ref: '#/components/schemas/BlockSeatsRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/seats/block: post: tags: - seats summary: Blocks seats on a specific piece of equipment. description: 'A blocked seat cannot be associated with/assigned to a passenger. The change can be verified on a unit''s availability on a seat map. GraphQL endpoint: seatsBlock' operationId: dcs_v1_seats_block_post requestBody: x-name: unitKeys description: The unit keys to block. content: application/json: schema: type: array items: type: string required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/dcs/v1/seats/unblock: delete: tags: - seats summary: Unblocks seats on a specific piece of equipment. description: 'The change can be verified on a unit''s availability on a seat map. GraphQL endpoint: seatsUnblock' operationId: dcs_v1_seats_unblock_delete requestBody: x-name: unitKeys description: The unit keys to unblock. content: application/json: schema: type: array items: type: string required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/settings/booking: get: tags: - settings summary: Get the general settings. description: 'GraphQL endpoint: settingsBookingGeneral' operationId: nsk_v1_settings_booking_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGeneralSettings' examples: Retrieve General Settings: description: Example response for successfully retrieving the booking general settings value: data: allowChangeSsrOnCheckedInPassenger: true allowBlockedSeatAssignment: false allowChangeOnRestrictedFlight: false allowPromoCodes: true allowEditableApiChannel: true allowEditableDirectChannel: true allowEditableGdsBookingWithTaPayment: true allowEditableGdsChannel: true allowEditableWebChannel: true allowGroupNameUpdates: true allowManifestRetrievalOnUnblockedFlightLines: true allowOverbookingSsrOnMove: false allowQueueingGdsBookingWithTaFopForETicketReissue: false allowRestrictedSeatAssignment: false allowSeatAssignment: 2 bookingAccessControl: 7 viewBookingsByControl: 3 editBookingsByControl: 3 defaultBookingComment: null doNotIncludeUnitProperties: true duplicateBookingDetectionTimeSpan: 00:00:00 enableAutomaticSeatAssignment: true highlightFareOverride: 0 highlightIrop: 0 highlightScheduleChange: 0 highlightStandby: 0 highlightUpgrade: 0 managePassiveSegments: true maskHistory: true reassignSeatingBehavior: 0 restrictedExternalSystemCodes: [] timeDisplay: 0 allowSeatGroupRestrictionOverride: true allowAccessToComments: true sharedCommentTypes: reservation: true itinerary: true manifest: true alert: true allowOverrideOfSalesChannel: true autoFillContactInformationByPhoneNumber: false allowAccessToArchivedBooking: true allowQueueBookingsOnSpecifiedLeg: false queueFlightOpenTimeSpan: 00:00:00 queueFlightCloseTimeSpan: 00:00:00 allowReleaseHeldSessionSeat: false /api/nsk/v1/settings/booking/checkin: get: tags: - settings summary: Get the checkin settings. description: 'GraphQL endpoint: settingsBookingCheckIn' operationId: nsk_v1_settings_booking_checkin_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCheckInSettings' /api/nsk/v1/settings/booking/contact: get: tags: - settings summary: Get the contact settings. description: 'GraphQL endpoint: settingsBookingContactv2' operationId: nsk_v1_settings_booking_contact_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfContactSettings' /api/nsk/v1/settings/booking/customerAccount: get: tags: - settings summary: Gets the role-based customer account settings. description: 'GraphQL endpoint: settingsBookingCustomerAccountv2' operationId: nsk_v1_settings_booking_customerAccount_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerAccountSettings' examples: Retrieve Customer Account Settings: description: Example response for successfully retrieving the booking customer account settings value: data: allowCustomerMerge: true allowCustomerProgram: true allowSeatLocationOption: true customerAccessControl: 1 defaultCustomerNotificationPreference: 0 defaultSeatPreference: 0 disableCustomerAddress: 0 disableCustomerCurrency: 1 disableCustomerDateOfBirth: 0 disableCustomerEmail: 1 disableCustomerFax: 1 disableCustomerLanguage: 1 disableCustomerNationality: 1 disableCustomerNotificationPreference: 1 disableCustomerPayment: 0 disableCustomerPhone: 1 disableCustomerResidentCountry: 1 disableCustomerTitle: 1 disableCustomerType: 0 allowAgentToModifyProgramLevel: true maskCustomerName: true maskCustomerSuffix: true maskTravelDocumentDetails: true maskCustomerWebUserId: true maskCustomerGender: true maskAffiliation: true /api/nsk/v1/settings/booking/fee: get: tags: - settings summary: Get the fee settings. description: 'GraphQL endpoint: settingsBookingFee' operationId: nsk_v1_settings_booking_fee_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFeeSettings' /api/nsk/v1/settings/booking/flightSearch: get: tags: - settings summary: Get the flight search settings. description: 'GraphQL endpoint: settingsBookingFlightSearch' operationId: nsk_v1_settings_booking_flightSearch_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFlightSearchSettings' post: tags: - settings summary: Create the flight search settings. description: 'GraphQL endpoint: settingsBookingFlightSearchAdd' operationId: nsk_v1_settings_booking_flightSearch_post requestBody: x-name: query description: The role code query. content: application/json: schema: $ref: '#/components/schemas/RoleCodeQuery' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - settings summary: Edit the role based flight search settings. description: 'GraphQL endpoint: settingsBookingFlightSearchSet' operationId: nsk_v1_settings_booking_flightSearch_put parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 1 requestBody: x-name: request description: The flight search settings request. content: application/json: schema: $ref: '#/components/schemas/FlightSearchSettings' required: true x-position: 2 responses: '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - settings summary: Patches the role based flight search settings. description: 'GraphQL endpoint: settingsBookingFlightSearchModify' operationId: nsk_v1_settings_booking_flightSearch_patch parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 1 requestBody: x-name: request description: The flight search settings request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfFlightSearchSettings' required: true x-position: 2 responses: '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/settings/booking/general: get: tags: - settings summary: Gets the non-role based general booking settings. description: 'GraphQL endpoint: generalBookingSettings' operationId: nsk_v1_settings_booking_general_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGeneralBookingSettings' examples: Retrieve General Booking Settings Response: description: Example response for successfully retrieving the general booking settings. value: data: maximumAgeForInfantInLap: 24 useDirectCurrencyConversion: true clearInfantDetailsWhenInfantInLapIsDeleted: true mixedClassRouteFaresEnabled: true sumOfSectorFaresEnabled: true sumOfSectorProductClassPreCompression: true sellSeatSsrBeforeAssignment: true applyAllUpPricingGlobally: true repriceWhenCustomerProgramIsChanged: true recalculateHoldWithBookingChanges: true preventCommitBookingWithCancelledInventory: true defaultCarrierCode: NV defaultBookingSubQueueCode: Unknwn maximumNumberOfMarkets: 6 interlineHoldBeforeDeparture: 2880 warningTimeBeforeHoldCancel: 0 interlineConnectionPartners: G3 applyFareForInLapInfantWithPassengerType: ' ' validateMaximumAgeBy: FirstSegment validateMinimumAgeBy: FirstSegment indiaGstRegistrationContactType: None enforceStandardGroupBooking: true storeConfirmingWaivedFees: true personallyIdentifiableInformationMasking: true lowFareCacheMode: null retrieveFareInformationFromGeneralReferenceManagement: true enableGenderNeutral: true storeDeletedManuallyAddedFees: true invalidNameCharacters: '@' /api/nsk/v1/settings/booking/passenger: get: tags: - settings summary: Get the passenger settings. description: 'GraphQL endpoint: settingsBookingPassenger' operationId: nsk_v1_settings_booking_passenger_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerSettings' post: tags: - settings summary: Create the passenger info settings. description: 'GraphQL endpoint: settingsBookingPassengerAdd' operationId: nsk_v1_settings_booking_passenger_post requestBody: x-name: query description: The role code query. content: application/json: schema: $ref: '#/components/schemas/RoleCodeQuery' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - settings summary: Edit the role based passenger info settings. description: 'GraphQL endpoint: settingsBookingPassengerSet' operationId: nsk_v1_settings_booking_passenger_put parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 1 requestBody: x-name: request description: The passenger settings request. content: application/json: schema: $ref: '#/components/schemas/PassengerSettings' required: true x-position: 2 responses: '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - settings summary: Patches the role based passenger info settings. description: 'GraphQL endpoint: settingsBookingPassengerModify' operationId: nsk_v1_settings_booking_passenger_patch parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 1 requestBody: x-name: request description: The passenger settings request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPassengerSettings' required: true x-position: 2 responses: '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/settings/booking/payment: get: tags: - settings summary: Get the role based booking payment settings. description: 'GraphQL endpoint: settingsBookingPaymentv2' operationId: nsk_v2_settings_booking_payment_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingPaymentSettingsv2' examples: Retrieve Booking Payment Settings v2: description: Example response for successfully retrieving the booking payment settings v2 value: data: allowExternalPaymentChargeBack: true allowHoldDateOverride: true allowIgnoreVoucherRestrictions: true allowVoucherIssuance: true allowManualAuthorization: true allowOverPay: true allowUnderPay: true allowUnvoidVoucher: true allowUseOfBinFraudTool: true allowVoidVoucher: true enableAutoPaymentVerification: true allowConfirmBookingWithPartialTicketing: true allowUnmaskingCreditCardNumber: true allowDisplayNoPaymentWarning: true requirePassengerOrContactForCreditFile: true requirePassengerOrContactForCreditShell: true requireCommentsForCreditShell: true disableAlternateAgAccount: true creditShellCreditCode: BKGI30 maxInstallmentOverride: 1 maxPaymentQueries: 1 secondsTillStartPaymentQuery: 1 secondsTillRepeatPaymentQuery: 1 holdsDaysBeforeDeparture: 10.00:00:00 holdsDaysAfterDeparture: -00:01:00 allowPendingCustomerActionAuthorization: true allowManualAuthorizationOfPendingPaymentWithoutValidation: false maskPaymentFields: true allowManualAuthorizationOfPaymentStatuses: - 3 - 2 - 6 - 4 displayVoucherNumber: true allowOverPayWithVoucherPayment: true allowVoucherOwnerUpdate: true post: tags: - settings summary: BETA - Create the booking payment settings based on the parent role code. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. See /api/nsk/v1/resources/roles/{roleCode}/settings to verify if settings have been configured for this role. Even without unique settings being configured for a role the GET call will always return data due to it returning the effective permissions of the role. This can potentially be based on the parent roles. GraphQL endpoint: settingsBookingPaymentAdd' operationId: nsk_v2_settings_booking_payment_post parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - settings summary: BETA - Edit the role based booking payment settings. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. GraphQL endpoint: settingsBookingPaymentSet' operationId: nsk_v2_settings_booking_payment_put parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 1 requestBody: x-name: request description: The new booking payment settings. content: application/json: schema: $ref: '#/components/schemas/BookingPaymentSettingsv2' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/BookingPaymentSettingsv2' patch: tags: - settings summary: BETA - Partially edit the role based booking payment settings. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. GraphQL endpoint: settingsBookingPaymentModify' operationId: nsk_v2_settings_booking_payment_patch parameters: - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 1 requestBody: x-name: request description: The new booking payment settings. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfBookingPaymentSettingsv2' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/BookingPaymentSettingsv2' /api/nsk/v1/settings/booking/paymentCodes: get: tags: - settings summary: Gets the role-based booking payment codes settings. description: 'GraphQL endpoint: settingsBookingPaymentCodes' operationId: nsk_v1_settings_booking_paymentCodes_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBookingPaymentCodesSettings' examples: Booking Payment Codes Settings: description: Example response for successfully retrieving the booking payment codes settings. value: data: voucherConfigurationCodes: - VOUCH1 - XVOUCH - VOUCHR /api/nsk/v1/settings/booking/reserveFlights: get: tags: - settings summary: Get the reserve flight settings. description: 'GraphQL endpoint: settingsReserveFlights' operationId: nsk_v1_settings_booking_reserveFlights_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfReserveFlightsSettings' examples: Retrieve Booking Reserve Flights Settings: description: Example response for successfully retrieving the booking reserve flights settings value: data: availabilityDepartureTimeLimit: -41.15:00:00 availabilityMaxDaysOut: 60.00:00:00 sellDepartureTimeLimit: -416.15:00:00 availableSpaceDisplayMax: 0 flightTimeChangeToleranceMinutes: 0 viewCapacity: false viewLidSold: false viewSsrAvailability: true viewManifestControl: 2 adHocFlightControl: 0 allowSellOverbook: 0 allowMoveOverbook: 0 allowUpgradeOverbook: 0 allowSplitJourneyMoves: false allowMove: 2 moveByMaximumClassAvailability: true requireSameCityPairOnMoves: false maxMoveDaysForward: 365.00:00:00 maxMoveDaysBack: 365.00:00:00 daysBeforeIrop: 365.00:00:00 allowFareOverride: true allowClosedFlightFareOverride: true allowFareOverrideDuringDivide: true allowIgnoreRestrictions: true allowInvalidPriceStatus: true cancelDepartureTimeLimit: -1000.00:00:00 seatAssignmentTimeLimit: -05:00:00 allowUpgrade: false allowCreateAdhocConnect: true minimumTimeBetweenFlightsEnforcement: true upgradeDepartureTimeLimit: 01:00:00 upgradeCabinStartOffset: 208.08:00:00 minimumTimeBetweenFlights: 00:00:00 modifyPassiveSegmentTimes: true allowSellOfFlightOverlap: false availabilityMaxDate: '9999-12-31T23:59:59.9999999' allowedFareOverrideType: 2 allowMoveOnInitialBooking: false allowDowngrade: true allowDowngradeOverbook: 3 allowRestoreOverbook: 0 enableCheckValidPrice: true enableTroubleshootingButton: true /api/nsk/v1/settings/customerPrograms: get: tags: - settings summary: Gets customer program settings. description: 'GraphQL endpoint: settingsCustomerProgram' operationId: nsk_v1_settings_customerPrograms_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerProgramSettings' /api/nsk/v1/settings/eTickets: get: tags: - settings summary: Gets the non-role based e-ticket configuration. description: 'GraphQL endpoint: settingsETickets' operationId: nsk_v1_settings_eTickets_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfETicketConfiguration' /api/nsk/v1/settings/externalMessageControls: get: tags: - settings summary: Gets the external message control settings. description: 'GraphQL endpoint: settingsExternalMessageControls' operationId: nsk_v1_settings_externalMessageControls_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfExternalMessageControls' examples: Retrieve External Message Controls Settings: description: Example response for successfully retrieving the external message controls settings value: data: carrierCodes: - NV - AD - JQ - '40' /api/nsk/v1/settings/general/applicationLogon: get: tags: - settings summary: Retrieves the logon settings. description: 'GraphQL endpoint: settingsApplicationLogon' operationId: nsk_v1_settings_general_applicationLogon_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfLogonSettings' /api/nsk/v1/settings/general/codes: get: tags: - settings summary: Retrieves the codes settings. description: 'GraphQL endpoint: settingsCodes' operationId: nsk_v1_settings_general_codes_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCodesSettings' examples: Retrieve Code Settings: description: Example response for successfully retrieving the code settings value: data: allowedPaymentMethodsForFraudPrevention: a3\ExternalAccount: true aC\PrePaid: false automaticMoveNestOverbookClasses: - ASCAR - AD - XY editableRuleTypes: - AgencyPOSControls - AvailabilitySource - BaggageAllowance - BaggageCheckInRestrictionContext - BaggageJourneyMarketRank - BarcodeFastTrackConfiguration externalPaymentValidationOverrides: a3\ExternalAccount: true aC\PrePaid: false overrideFeeTypes: - 2 - 3 - 4 - 5 - 6 paymentFieldOverrides: a3\ExternalAccount: amount: 1 accountNumber: 1 cvv: 0 privateTravelQueueCategory: 1 publicTravelQueueCategory: 2 refundablePaymentMethodCodes: - A3\ExternalAccount - AC\PrePaid - AG\AgencyAccount - AP\ExternalAccount spoilFeeTypes: - 1 - 3 - 4 - 5 - 6 classOfServices: - AC - BA - CC depositPaymentTypes: - A3\ExternalAccount - AC\PrePaid - AG\AgencyAccount - AP\ExternalAccount fareTypes: - R - AP - B - C - D - DE - DF - DG - EX - F - FC - M - PE - S - SH - SL - US - W - X passengerDiscountCodes: - 5P - ADT - ALPX - CHLD - CORP - EXT - FRQF - INET - MLTY - NK1 - NK2 - NK3 - NK4 - SNR - VIP passengerTypeCodes: - ADT - CHD - INF - MLT - SRC paymentMethodCodes: - A3\ExternalAccount - AC\PrePaid - AG\AgencyAccount - AP\ExternalAccount - AX\ExternalAccount - BN\ExternalAccount penaltyFeeCodes: - AFLY - APOPF - CGX - CHF1 - CHG productClasses: - 2C - 2Y - A1 - A2 - A3 - A4 queueCategoryCodes: a: 1 b: 2 c: 3 sellSsrCodes: - 1BAG - 1BGP - 2BAG - 2BGP serviceFeeCodes: - AKFEE1 - APOSF - APOSFC - ASFE standbyClassOfServiceCodes: - AC - BA - CC stationCategories: - A - B - C viewableSeatProperties: - AISLE - AMBIANCE/SOCIAL - AMBIANCE/BUSINESS - AMBIANCE/FAMILY waiveFeeTypes: - 1 - 3 - 4 - 5 - 6 defaultFareType: R /api/nsk/v1/settings/general/operations: get: tags: - settings summary: Retrieves the operations settings. description: 'GraphQL endpoint: operationsSettings' operationId: nsk_v1_settings_general_operations_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Role Code: description: Example Error if role code is invalid value: errors: - id: d05ebc4a-2534-428d-bdf0-284876cf8c64 code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''1234'' is out of range for ''SettingsQueryBase.RoleCode''. Expected values: (ABD1,ABD2,ABD3,ABD4,ABT1,AIKO,AIR,AIRM,APIL,APIM,APOM,APT,APTM,APTS,ASR1,ASR2,ASR3,ASR4,ASRC,AUT2,AUT3,AUTM,BAGR,BKGP,BPR1,CAPP,CFS1,CHAM,CIBR,CIR1,CIR2,CPC1,CSF2,CSNA,DEV,DICR,DOCS,GDS,GN1,GN10,GN11,GN12,GN13,GN2,GN3,GN4,GN5,GN6,GN7,GN8,GN9,GNAG,GNAM,GND,GNP,GNRO,GNTC,GSS,ICON,IROP,IRP1,ISB1,ISB2,JAMS,JR1,JROL,JSR,KIUS,KSKM,MAMA,MAW3,MAWI,MBT1,MBT2,NBD1,NDC1,NDC2,NDCI,NDCM,NDCS,NEH1,NEH2,NEH3,NEH4,NEH5,NEH6,OPSM,PBG1,REPA,REPB,REPM,RES,RESM,RESS,RMEB,RPTA,RPTB,RPTC,RPTD,RPTM,RPTP,RPTU,RPU,SKPM,SYSM,TAMA,TAW3,TC,TIBS,TSM,UPC1,WSER,WWWA,WWWM,XBPS,XFSS,YSA,ZBPS,ZFSS)' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOperationsSettings' examples: Retrieve Operations Settings: description: Example response for successfully retrieving the operations settings value: data: overrideOverWingExitRowRequirement: true iropFromDepartureDateOffset: 10.00:00:00 allowDiversionIrop: true allowConsoleIrop: true allowCreateAdHocConnectionsInIrop: true allowIropOversellOnToFlight: true flightFollowingAccessControl: 7 allowAircraftMishapUtilityAccess: true allowCheckedBaggageWeightChange: true allowOpeningOfClosedFlights: true timeBeforeDepartureThatCloseFlightIsAllowed: 10.00:00:00 timeAfterDepartureThatOpenFlightIsAllowed: 10.00:00:00 allowClearPassengerDataInAircraftMishap: true allowRestorePassengerDataInAircraftMishap: true allowInventoryStatusChange: true adHocFromCurrentDateOffset: 10.00:00:00 bagDropMode: 0 allowCrewBagAccess: true allowRushBagAccess: true allowCrewBagCheckInWhenFlightIsClosedPending: true allowRushBagCheckInWhenFlightIsClosedPending: true allowMarketingCheckIn: true verifyAPISInternationalFlight: true allowInventorySSRMaintenanceUpdate: true allowInventoryRecordMaintenanceUpdate: true allowCancelRestoreInventory: true allowDiversionAdHoc: true allowManageTailNumber: true allowEquipmentSwapUtilityAccess: true allowRZAccess: true allowUpdateStandbyPriorityCode: true allowManageVoucher: true flightInformationPermissions: 1 allowSegmentsByTime: true allowBaggageTrackingAccess: true enableFlightSearchRestrictionByOrigin: true allowBaggageModeSwitchToIBCMode: true daysForwardAllowedForSearchingCheckInAndReports: 30.00:00:00 daysPriorAllowedForSearchingCheckInAndReports: 30.00:00:00 sendAPISReport: true watchList: allowViewForWatchList: true allowDetailViewForWatchList: true allowClearPassengerFromWatchList: true programs: sendSITAMessage: true sendMessage: true adHocScheduleInventoryConnections: true allowCAPPSReportAccess: true allowCheckInSelectee: true reports: enplanementDeplanement: true manifestConnectionInfo: true manifestDetailedInfo: true flightLoad: true checkIn: true aircraftZone: true seatAssignment: true flightClose: true paymentReceipt: true paymentReceiptConfigurations: displayLocationPrompt: true checkedBaggage: true availability: true bagWeightByLeg: true selecteesByFlight: true mealFulfillment: true flightManifest: true flightManifestConfigurations: identifySelecteePassengers: true identifyPassengersWithBalanceDue: true prePostFlightManifest: true cabinServiceArea: true displayPNRInCabinServiceAreaAndMealFulfillmentReports: true /api/nsk/v1/settings/general/organization: get: tags: - settings summary: Gets the organization settings. description: 'GraphQL endpoint: settingsOrganization' operationId: nsk_v1_settings_general_organization_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationSettings' /api/nsk/v1/settings/general/session: get: tags: - settings summary: Retrieves the session settings. description: 'GraphQL endpoint: settingsSession' operationId: nsk_v1_settings_general_session_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSessionSettings' /api/nsk/v1/settings/itinerary: get: tags: - settings summary: Gets the itinerary settings. description: 'GraphQL endpoint: itinerarySettings' operationId: nsk_v1_settings_itinerary_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfItinerarySettings' /api/nsk/v1/settings/loyalty: get: tags: - settings summary: Gets the non-role based loyalty settings. description: 'GraphQL endpoint: settingsLoyalty' operationId: nsk_v1_settings_loyalty_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfLoyaltySettings' /api/nsk/v1/settings/notifications/general: get: tags: - settings summary: Gets the general New Skies notification settings. description: 'GraphQL endpoint: settingsGeneralNotifications' operationId: nsk_v1_settings_notifications_general_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGeneralNotificationsSettings' examples: Retrieve Notifications Settings: description: Example response for successfully retrieving the notifications settings value: data: enableTicketControlNumberNotifications: true /api/nsk/v1/settings/payment: get: tags: - settings summary: Get the non role based payment settings. description: 'GraphQL endpoint: settingsPayment' operationId: nsk_v1_settings_payment_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentSettings' examples: Retrieve General Payment Settings Response: description: Example response for successfully retrieving the general payment settings. value: data: defaultCommentForCreditShell: comment webDeclinedPaymentHoldPeriod: 15 directDeclinedPaymentHoldPeriod: 1 gdsDeclinedPaymentHoldPeriod: 11 apiDeclinedPaymentHoldPeriod: 2 autoCancelChargeBackPaymentHolds: true allowZeroAmountFormOfPayment: true includeInFirstInstallmentFeeCodes: - PF01 - PFAU5 - PFAU6 retainHoldStatusUntilPaymentAuthorization: true validateCurrencyEnforcedAgainstPaymentType: 1 numberOfDeclinedRefundAndReverseAttempts: 0 /api/nsk/v1/settings/phoneNumberValidation: get: tags: - settings summary: Gets the non-role based phone number validation settings. description: 'GraphQL endpoint: settingsPhoneNumberValidation' operationId: nsk_v1_settings_phoneNumberValidation_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPhoneNumberValidationSettings' /api/nsk/v2/settings/premiumServices: get: tags: - settings summary: Retrieves the premium services settings. description: 'GraphQL endpoint: settingsPremiumServicesv2' operationId: nsk_v2_settings_premiumServices_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPremiumServicesSettingsv2' examples: Retrieve Premium Services Settings: description: Example response for successfully retrieving the premium services settings value: data: governmentDataProtectionRequirements: true accessToExternalBaggageSystems: true unitedKingdomInteractiveAdvancePassengerProcessing: true advancedParentChildTravelAgencyManagement: true doNotPersistExternalPaymentDetails: false baggageSelfTagging: true loyaltyCustomerAccountView: true pricingOptimizationServices: true secureFlight: true allInclusivePricingDisplay: true numericAddressVerificationService: true koreanInteractiveAdvancePassengerProcessing: true taiwanInteractiveAdvancePassengerProcessing: true canadaInteractiveAdvancePassengerProcessing: true attributeShopping: true documentCheckConfiguration: true transmitFareDataToAirlineTariffPublishingCompany: true travelNotifications: true bundles: true put: tags: - settings summary: BETA - Edit the premium service settings. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. This functionality is restricted to System Master users only.' operationId: nsk_v2_settings_premiumServices_put requestBody: x-name: request description: The new booking payment settings. content: application/json: schema: $ref: '#/components/schemas/PremiumServicesSettingsv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/settings/serviceBundles: get: tags: - settings summary: Gets the service bundles settings. description: 'GraphQL endpoint: settingsServiceBundles' operationId: nsk_v1_settings_serviceBundles_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfServiceBundlesSettings' /api/nsk/v2/settings/skySpeed: get: tags: - settings summary: Retrieves the role-based and non-role based SkySpeed settings. description: 'GraphQL endpoint: settingsSkySpeedv2' operationId: nsk_v2_settings_skySpeed_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSkySpeedSettingsv2' examples: Retrieve SkySpeed Settings v2: description: Example response for successfully retrieving the SkySpeed settings v2 value: data: disableBaseCurrency: false manifestViewDate: 0 disableOutboundTime: true maximumNumberOfTtyMessagesPerBatchForDeletion: 1000 excludeOutboundTimeTab: true postalCodeLookup: 0 disableReturnTime: true serviceServerName: 0 excludeReturnTimeTab: true enableViewPaymentAllocation: true enableShowValidFaresCheckbox: true fareBasisInRegularBooking: 9 fareBasisInOverbook: 9 displayReservedFlights: true displaySsrNestValues: true defaultFocusToCustomerIdField: true allowDeleteComments: true promptCreateInternetUserId: true allowManagePasswordForCustomerAccount: true viewFareQuote: true allowNonCarrierOrgToUseOtherAgency: true viewTeletypeProcessing: true viewGdsHistoryDialog: true returnDateDefaultToOutboundDate: true displayFyiNotesOnLogin: true displayResidentCountry: true displayPricesByPassengerType: null defaultToCustomerCreditCard: true forceViewMandatoryComments: true showTravelDocumentsOnPassengersScreen: true showDestinationAddressesOnPassengersScreen: true showFrequentFlyerNumberOnPassengersScreen: true showMealSsrButtonOnPassengersScreen: true allowETicketing: true allowFeesToBeDeleted: true displayReferenceNumber: true enableLoyaltyCustomerAccountView: true enableLoyaltyFareDisplay: true displayETicketRecords: true allowETicketCouponStatusToBeUpdated: true enableRepriceButtonOnReservedFlightsScreen: true enableSplitCancelButtonOnReservedFlightsScreen: true allowTravelNotificationsAccess: true allowThemeEditorAccess: true allowBlacklistAccessAndRetrieveReservationsFromPayments: true maskBookingContactInformation: false accessToFlightsWithTrafficRestrictions: true enabledTicketCodes: null reservationComments: null itineraryComments: null manifestComments: null enableDeletePassengerButton: true showMultiCityShoppingTabOnAvailabilityRequestScreen: true allowTcpOnDemand: true /api/nsk/v1/settings/system/general: get: tags: - settings summary: Gets the role-based general system settings. description: 'GraphQL endpoint: settingsGeneralSystem' operationId: nsk_v1_settings_system_general_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Settings not found.: description: Example when the settings cannot be retrieved. value: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Matching ETag: description: Response when an ETag is provided and the cached data still matches. value: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfGeneralSystemSettings' examples: Retrieve General System Settings: description: Example response for successfully retrieving the general system settings value: data: manageFYIContent: 7 manageGeneralReferenceManagement: 7 allowAccessToFyiContent: true manageQueues: 7 allowAgentToEmptyBookingQueues: true /api/nsk/v1/settings/systemConfiguration/finance: get: tags: - settings summary: Retrieves the session system configuration finance setting. description: 'GraphQL endpoint: systemConfigurationFinance' operationId: nsk_v1_settings_systemConfiguration_finance_get parameters: - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: string nullable: true x-position: 1 - name: RoleCode in: query description: "Gets or sets the role code for this request.\n " schema: type: string maxLength: 4 minLength: 1 nullable: true x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfFinanceSettings' examples: Retrieve System Configuration Finance: description: Example response for successfully retrieving the system configuration - finance settings value: data: financeAccess: 7 financeData: manageAccounts: 2 manageCreditTypes: 6 manageCurrency: 4 manageFareDiscountCodes: 0 manageFareSurcharges: 1 managePaymentTypes: 5 managePromotionCodes: 7 manageTaxesAndFees: 1 allowAgentToImportFeeVariations: true manageVouchers: 1 allowAccountReconciliation: true allowBalanceAndCreditLimitUpdate: true allowAccountStatementAdjustment: true manageFinancialControlLockDate: 0 /api/nsk/v1/settings/travelerNotification: get: tags: - settings summary: Gets the traveler notification settings. description: 'GraphQL endpoint: settingsTravelerNotification' operationId: nsk_v1_settings_travelerNotification_get parameters: - name: eTag in: query description: The eTag. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTravelerNotificationSettings' /api/nsk/v1/settings/user/agencyCreation: get: tags: - settings summary: Retrieves the agency creation settings. description: 'GraphQL endpoint: settingsAgencyCreation' operationId: nsk_v1_settings_user_agencyCreation_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAgencyCreationSettings' /api/nsk/v1/settings/user/customerCreation: get: tags: - settings summary: Retrieves the customer creation settings. description: 'GraphQL endpoint: settingsCustomerCreation' operationId: nsk_v1_settings_user_customerCreation_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: string nullable: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerCreationSettings' /api/v1/token: post: tags: - token summary: Creates the general access token that will grant access to the API. operationId: v1_token_post requestBody: x-name: request description: The token request. content: application/json: schema: $ref: '#/components/schemas/TokenRequest' examples: Default: description: A request is optional. With no request you will get back the default anonymous token. value: {} Application Specific: description: When supplying an application name you will get the default anonymous token configured for that application (if available). value: applicationName: WebApp x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTokenResponse' examples: Created: description: A successful token with the idle time out in minutes. value: data: token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJVbmtub3duIiwianRpIjoiZjZmNmQwMTAtOTM4OC0zM2Q1LTEwOGItYTk0NDNmMzcxMDc4IiwiaXNzIjoiZG90UkVaIEFQSSJ9.43Wh_19jHPHzEIPNxTUWaJQtTPHSkB_WmEPL-xxxxxx idleTimeoutInMinutes: 15 deprecated: true put: tags: - token summary: Keeps the active token alive. description: 'GraphQL endpoint: tokenKeepAlive' operationId: v1_token_put responses: '440': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Timed out: description: The token timed out, please get a new token. value: errors: - id: null code: core:Token:Timeout message: null type: Error details: null rawMessage: The provided token has timed out. 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 '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Ok: description: No content returned. value: data: null deprecated: true delete: tags: - token summary: Abandons the active token. description: 'GraphQL endpoint: tokenDelete' operationId: v1_token_delete responses: '440': description: '' content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Timed out: description: The token timed out, please get a new token. value: errors: - id: null code: core:Token:Timeout message: null type: Error details: null rawMessage: The provided token has timed out. 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 '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Ok: description: No content returned. value: data: null deprecated: true /api/auth/v1/token: get: tags: - token summary: Get the information about the short-lived JWT. description: 'With custom application names (system type in NewSkies), because of the nature of the underlying system type, the `NskServer.SystemName` will always show as `UserDefined`. To see the custom name, see the `ServerContext.ApplicationName`. GraphQL endpoint: jwtToken' operationId: auth_v1_token_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfJwtDetailsResponse' put: tags: - token summary: Updates the short-lived JWT. description: Updates the short-lived JWT. operationId: auth_v1_token_put requestBody: x-name: request description: The refresh request. content: application/json: schema: $ref: '#/components/schemas/JwtRefreshRequest' x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfJwtResponse' examples: JWT token creation successful: description: Successful token creation with valid user credentials. value: data: token: '**JWT Token**' cultureCode: en-US currencyCode: USD roleCode: AIR2 locationCode: HDQ domainCode: DEF organizationCode: '88888888' expires: '2026-07-09T06:10:14.6420287+00:00' userKey: NDEwMjQ- personKey: NzE3MzI- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: Agent not found: description: For security unless in debug mode for testing servers the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: No agent found for requested agent name DEF/authAppMFAUse. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid password: description: For security unless in debug mode for testing servers the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: The agent (DEF/authAppMFAUser) failed authentication. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid culture code: description: The provided culture code in the request is an invalid culture identifier. value: errors: - id: null code: nsk:CultureCode:InvalidCultureCode message: The culture code `asdf` is invalid. type: Validation details: null rawMessage: The culture code `asdf` is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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 Culture code not configured: description: The provided culture code in the request is not configured in the resources. For valid culture codes, see GET /api/nsk/v1/resources/cultures value: errors: - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfJwtResponse' /api/nsk/v1/token: get: tags: - token summary: Get the information about the current token. description: '- With custom application names (system type in NewSkies), because of the nature of the underlying system type, the `NskServer.SystemName` will always show as `UserDefined`. To see the custom name, see the `ServerContext.ApplicationName`. - The values `IsVirtual` and `HasBookingInState` no longer apply if the NSK JWT token is being used. GraphQL endpoint: token' operationId: nsk_v1_token_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNskSessionContext' deprecated: true delete: tags: - token summary: Abandons the active token. operationId: nsk_v1_token_delete responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/token: post: tags: - token summary: Creates the general access token that will grant access to the API. description: 'Security Note: This endpoint has the ability to log in as any role assigned to a user or that is allowed through impersonation settings. A user may still log into a role that is not assigned to them if the impersonation settings allow it.' operationId: nsk_v2_token_post requestBody: x-name: request description: The nsk token request. content: application/json: schema: $ref: '#/components/schemas/NskTokenRequestv2' x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMultiFactorTokenResponse' '202': description: Accepted, continue multi-factor authentication. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMultiFactorTokenResponse' examples: MFA registration required.: description: This role requires multi-factor authentication. This user has not yet choose the preferred type of MFA and registered with it. See POST /token/multifactor value: messages: - code: nsk-server:MFA:RegistrationRequired type: Information value: Multi-factor registration is required. status: 0 details: null data: multiFactorRequired: challengeId: null requiresRegistration: true requiresChallengeCode: false types: - 2 - 1 - 0 token: null idleTimeoutInMinutes: 0 MFA challenge required.: description: This role requires multi-factor authentication. This user has already registered but needs to use their chosen registration method for the 2nd factor authentication. value: messages: - code: nsk-server:MFA:ChallengeCodeRequired type: Information value: Multi-factor authentication required. Please check your second factor method and enter the challenge code. status: 0 details: null data: multiFactorRequired: challengeId: 01234567890123456789 requiresRegistration: false requiresChallengeCode: true types: - 0 token: null idleTimeoutInMinutes: 0 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: MFA registration required.: description: This role requires multi-factor authentication. This user has not yet choose the preferred type of MFA and registered with it. See POST /token/multifactor value: errors: - id: null code: nsk-server:MFA-RegistrationRequired message: Multi-factor registration is required. type: Validation details: null 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 MFA challenge required.: description: This role requires multi-factor authentication. This user has already registered but needs to use their chosen registration method for the 2nd factor authentication. The types returned represent the available types and not necessarily which type your 2FA was sent to. value: errors: - id: null code: nsk-server:MFA-ChallengeCodeRequired message: Multi-factor authentication required. Please check your second factor method and enter the challenge code. type: Validation details: null 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 deprecated: true put: tags: - token summary: 'Given a non-null request, upgrades the current session''s logged in user. Otherwise, keeps the active token alive.' description: 'Security Note: This endpoint has the ability to log in as any role assigned to a user or that is allowed through impersonation settings. A user may still log into a role that is not assigned to them if the impersonation settings allow it. GraphQL endpoint: tokenUpgradev2' operationId: nsk_v2_token_put requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/CredentialsBase' x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/auth/v1/token/anonymous: post: tags: - token summary: Create a short-lived anonymous JWT. description: 'Tokens have a set expiration time. Client applications should call the put endpoint to get a new token before this expiration time.' operationId: auth_v1_token_anonymous_post requestBody: x-name: request description: Get token request. content: application/json: schema: $ref: '#/components/schemas/JwtRefreshRequest' examples: Anonymous JWT Token Request: description: Example request for creating an anonymous JWT token. value: applicationName: Digital API cultureCode: en-US newSession: true Empty Request: description: An empty anonymous JWT token request. value: applicationName: null cultureCode: null newSession: false x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfJwtResponse' examples: JWT token creation successful: description: Successful token creation with valid anonymous credentials. value: data: token: '**JWT Token**' cultureCode: en-US currencyCode: USD roleCode: TAW3 locationCode: WWW domainCode: WW2 organizationCode: '88888888' expires: '2026-07-09T06:10:14.6132458+00:00' userKey: NDEwMjQ- personKey: NzE3MzI- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: Agent not found: description: For security unless in debug mode for testing servers the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: No agent found for requested agent name DEF/authAppMFAUse. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid password: description: For security unless in debug mode for testing servers the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: The agent (DEF/authAppMFAUser) failed authentication. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid culture code: description: The provided culture code in the request is an invalid culture identifier. value: errors: - id: null code: nsk:CultureCode:InvalidCultureCode message: The culture code `asdf` is invalid. type: Validation details: null rawMessage: The culture code `asdf` is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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 Culture code not configured: description: The provided culture code in the request is not configured in the resources. For valid culture codes, see GET /api/nsk/v1/resources/cultures value: errors: - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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 /api/nsk/v1/token/culture: post: tags: - token summary: Sets the culture code for the lifetime of the token. description: 'Note there is middleware that looks for "Culture" on every request in the headers or query string parameters. These can be used if you want to set the culture for a single request only. GraphQL endpoint: tokenCultureSet' operationId: nsk_v1_token_culture_post parameters: - name: defaultCultureCode in: query description: The culture code to use as the default for the life of this token. schema: type: string nullable: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/auth/v1/token/multifactor: post: tags: - token summary: Register multi-factor authentication options. description: 'Allows first time users to select their multifactor authentication method and will send a challenge code to that method.' operationId: auth_v1_token_multifactor_post requestBody: x-name: request description: The multi-factor registration request content: application/json: schema: $ref: '#/components/schemas/MultiFactorRegisterRequest' examples: Register Email: description: Initial request to register an email. value: credentials: domain: DEF username: agent123 password: '*******' registration: email: getChallengeCode@mfa.com type: 0 Verify: description: Second request to verify the challenge code with a challenge id. value: credentials: domain: DEF username: agent123 password: '*******' verify: challengeCode: '012345' challengeId: 01234567890123456789 Register SMS: description: Initial request to register an phone number. value: credentials: domain: DEF username: agent123 password: '*******' registration: phone: 123-123-1234 type: 1 Register TOTP: description: Initial request to register an authenticator app. value: credentials: domain: DEF username: agent123 password: '*******' registration: type: 2 required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMultiFactorRegisterResponse' examples: Verified Example: description: MFA registrations has been verified. This will only need to be done once and the user can now proceed to POST /token/user to restart the authentication process. value: data: qrCodeUrl: null challengeId: null '202': description: Waiting on additional data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMultiFactorRegisterResponse' examples: TOTP Example: description: This value can be used in websites or by devs using sites such as https://jaredwinick.github.io/base64-image-viewer/ and would be scanned by an authenticator app to provide the challenge code. Next please call this same endpoint to verify the MFA registration. value: data: qrCodeUrl: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAeoAAAHqAQAAAADjFjCXAAADHElEQVR42u2dW47bMAxFiXoBXpK27iV5AQY0jsyXkkE/Sg3QoscfRjLx+TEuSF2S0kivXIeAg4ODg4ODg4P/Tbjotd2f9uv53PsZt+1+dL+fa6c92gb+S0oX+P+Jq+qGhkJcQ3/t1F9vbW7dlLj1RKA68IrqXjGsDdVZ1LuvS24Rvm7Pc9fziGoS1YEvU90rmqm4Rq4doc9vqA7852LdI7grp1T/iurAf2Zd91Kd/k1SwGNdB75QdeFh2/n7Gx4WfJHq4noS6RGxzi3Ft4UX3jx4Idbtl7kJK5WY4DzNiqRHiHXgi1Q3hLR3tRRuaR/9jcrJuzp58+A1D6sGdajOiiaRYaNoEpYC1YHX3IQXQ9yvapod2dS6ZONvsepDdeAVN+Gxrr3bh6Gwy3sTkn9FdeAlDxvOQaskGtckGwmtJndiHfgC1anCNi8Va/c1yica8KJyh+rAyx72s936fntUNyBUB77Ew+bGgzVjtWkRHtZqKFSJwRdl2Nzun0La5DCiaYHqwIuqs7yqpToLeI+5PcSdawxDoTrwBR5Wy3KpD3uZ6vyrKhHVga9Y180GNc3X9SkINs+/qA58Raz7GC05dW499u2kLgXrOvD6us4bD7KlCc6pLbGlHgaqAy9nWN+ek6fqXj+32JlocjQlojrwaoY16c2xztLsN19RHXhVdWEQRD9Z+U7kY6MObgJ8iYe1PWIW5kTSRp1m4yY2c8csMfiidZ2VSnLjPy3z9IcthUNUB17zsHNbbBqos/l2l97Oug58SawTV9Pl6zorEHupzvplVE7AV6jOuq+mv9wRy7HO139kWPC66vp0sIlMFeFD8hkBOTHz5sGrGVYk+YU8jOKbEseVjhjjzYP/uZuY9/5PW2G1XxaTJqzrwBefc5I7/aeelZiNrO/lQXXgVdW11POaZtmj8X/4aLFWjlEdeFF1KbjFCXXXNH3X3eayCxt8reraXDRuKeGq4OhNgC8/q3PeN+GH7cT2MOp14IvXdTHLno6/TjsohF3Y4OvP6oy5zWOfqiQ97eWhDwteVx3/IAYcHBwcHBwc/F/HvwBzCfzfcRsB9wAAAABJRU5ErkJggg== challengeId: 01234567890123456789 Email or SMS Example: description: An email will be sent that provides a challenge code. Next please call this same endpoint to verify the MFA registration. If registration is not verified then it will timeout after 10 minutes and will be required again in future authentication calls. value: data: qrCodeUrl: null challengeId: 01234567890123456789 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: Already registered.: description: This can occur when already registered or waiting for the registration challenge code. Please try again later. value: errors: - id: null code: nsk-server:MFA:Registered message: Already registered or waiting for the registration challenge code. To restart the registration process try again after the configured amount of time. type: Error details: null 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 '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: MFA service down.: description: Internal server problem with authentication. Please try again later. value: errors: - id: null code: nsk-server:Credentials:Issue message: nsk-server:Credentials:Issue type: Error details: null rawMessage: 'Error calling IMFAService.authenticateAdmin: MFA service unavaliable.' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/auth/v1/token/role: put: tags: - token summary: Updates the short-lived JWT with new role permissions. description: Updates the short-lived JWT with new role permissions. operationId: auth_v1_token_role_put requestBody: x-name: request description: The update request. content: application/json: schema: $ref: '#/components/schemas/JwtImpersonateRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfJwtResponse' examples: JWT token creation successful: description: Successful token creation with valid user credentials. value: data: token: '**JWT Token**' cultureCode: en-US currencyCode: USD roleCode: AIR2 locationCode: HDQ domainCode: DEF organizationCode: '88888888' expires: '2026-07-09T06:10:14.6436805+00:00' userKey: NDEwMjQ- personKey: NzE3MzI- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: Agent not found: description: For security unless in debug mode for testing servers the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: No agent found for requested agent name DEF/authAppMFAUse. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid password: description: For security unless in debug mode for testing servers the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: The agent (DEF/authAppMFAUser) failed authentication. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid culture code: description: The provided culture code in the request is an invalid culture identifier. value: errors: - id: null code: nsk:CultureCode:InvalidCultureCode message: The culture code `asdf` is invalid. type: Validation details: null rawMessage: The culture code `asdf` is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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 Culture code not configured: description: The provided culture code in the request is not configured in the resources. For valid culture codes, see GET /api/nsk/v1/resources/cultures value: errors: - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfJwtResponse' /api/nsk/v1/token/serverTransfer: post: tags: - token summary: Transfers the server context from NewSkies and returns a new token. description: 'This endpoint returns a new token. The new token must be applied in the authorization header to access the transferred server context. GraphQL endpoint: serverTransferAdd' operationId: nsk_v1_token_serverTransfer_post requestBody: x-name: request description: The server transfer request. content: application/json: schema: $ref: '#/components/schemas/ServerTransferRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTokenResponse' deprecated: true /api/nsk/v1/token/singleSignOn: post: tags: - token summary: Creates the general access token that will grant access to the API. description: 'In order to use single sign on, a single sign on token must first be associated with a user. Refer to the "user/singleSignOnToken" endpoints. GraphQL endpoint: singleSignOn' operationId: nsk_v1_token_singleSignOn_post requestBody: x-name: credentials description: The single sign on credentials. content: application/json: schema: $ref: '#/components/schemas/SingleSignOnCredentials' x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTokenResponse' put: tags: - token summary: 'Given a non-null request, upgrades the current session''s logged-in user. Otherwise, keeps the active token alive.' description: 'In order to use single sign on, a single sign on token must first be associated with a user. Refer to the "user/singleSignOnToken" endpoints. GraphQL endpoint: singleSignOnUpgrade' operationId: nsk_v1_token_singleSignOn_put requestBody: x-name: credentials description: The single sign on credentials. content: application/json: schema: $ref: '#/components/schemas/SingleSignOnCredentials' x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/auth/v1/token/user: post: tags: - token summary: Creates a short-lived JWT specific to a user. description: 'Tokens have a set expiration time. Client applications should call the put endpoint to get a new token before this expiration time.' operationId: auth_v1_token_user_post requestBody: x-name: request description: The nsk token request. content: application/json: schema: $ref: '#/components/schemas/JwtRequest' examples: Standard JWT Token Request: description: Example request for creating a JWT token. value: credentials: username: agent123 alternateIdentifier: null password: '*******' domain: DEF location: null loginRole: null applicationName: Digital API cultureCode: en-US multiFactor: null Multifactor Request: description: Example request after receiving multifactor challenge code. value: credentials: username: agent123 alternateIdentifier: null password: '*******' domain: DEF location: null loginRole: null applicationName: Digital API cultureCode: en-US multiFactor: challengeCode: '123456' challengeId: 01234567890123456789 requestIdentityToken: false x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMultiFactorJwtResponse' examples: JWT token creation successful: description: Successful token creation with valid user credentials. value: data: multiFactorRequired: null token: '**JWT Token**' cultureCode: en-US currencyCode: USD roleCode: AIR2 locationCode: HDQ domainCode: DEF organizationCode: '88888888' expires: '2026-07-09T06:10:14.6238751+00:00' userKey: NDEwMjQ- personKey: NzE3MzI- Multifactor JWT token creation successful: description: Successful token creation with valid user credentials for multifactor authentication. value: data: multiFactorRequired: challengeId: 01234567890123456789 requiresRegistration: false requiresChallengeCode: true types: - 0 token: '**JWT Token**' cultureCode: en-US currencyCode: USD roleCode: AIR2 locationCode: HDQ domainCode: DEF organizationCode: '88888888' expires: '2026-07-09T06:10:14.6244198+00:00' userKey: NDEwMjQ- personKey: NzE3MzI- '202': description: Waiting on additional data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMultiFactorJwtResponse' examples: MFA registration required.: description: This role requires multi-factor authentication. This user has not yet chosen the preferred type of MFA and registered with it. See POST /token/multifactor value: messages: - code: nsk-server:MFA-RegistrationRequired type: Information value: Multi-factor registration is required. status: 0 details: null data: multiFactorRequired: challengeId: null requiresRegistration: true requiresChallengeCode: false types: - 2 - 1 - 0 token: null cultureCode: null currencyCode: null roleCode: null locationCode: null domainCode: null organizationCode: null expires: null userKey: null personKey: null MFA challenge required.: description: This role requires multi-factor authentication. This user has already registered but needs to use their chosen registration method for the 2nd factor authentication. value: messages: - code: nsk-server:MFA-ChallengeCodeRequired type: Information value: Multi-factor authentication required. Please check your second factor method and enter the challenge code. status: 0 details: null data: multiFactorRequired: challengeId: 01234567890123456789 requiresRegistration: false requiresChallengeCode: true types: - 0 token: null cultureCode: null currencyCode: null roleCode: null locationCode: null domainCode: null organizationCode: null expires: null userKey: null personKey: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: Challenge code failed: description: For security, unless in debug mode for testing servers, the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: Challenge code failed validation for user DEF/authAppMFAUser. 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 Agent not found: description: For security, unless in debug mode for testing servers, the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: No agent found for requested agent name DEF/authAppMFAUse. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid password: description: For security, unless in debug mode for testing servers, the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: The agent (DEF/authAppMFAUser) failed authentication. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid culture code: description: The provided culture code in the request is an invalid culture identifier. value: errors: - id: null code: nsk:CultureCode:InvalidCultureCode message: The culture code `asdf` is invalid. type: Validation details: null rawMessage: The culture code `asdf` is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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 Culture code not configured: description: The provided culture code in the request is not configured in the resources. For valid culture codes, see GET /api/nsk/v1/resources/cultures value: errors: - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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 '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: MFA service down.: description: Internal server problem with authentication. Please try again later. value: errors: - id: null code: nsk-server:Credentials:Issue message: nsk-server:Credentials:Issue type: Error details: null rawMessage: 'Error calling IMFAService.authenticateAdmin: MFA service unavaliable.' 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 put: tags: - token summary: Updates an anonymous short-lived JWT to login as a user. description: Updates an anonymous short-lived JWT to login as a user. operationId: auth_v1_token_user_put requestBody: x-name: request description: The nsk token request. content: application/json: schema: $ref: '#/components/schemas/JwtRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfJwtResponse' examples: JWT token creation successful: description: Successful token creation with valid user credentials. value: data: token: '**JWT Token**' cultureCode: en-US currencyCode: USD roleCode: AIR2 locationCode: HDQ domainCode: DEF organizationCode: '88888888' expires: '2026-07-09T06:10:14.6410372+00:00' userKey: NDEwMjQ- personKey: NzE3MzI- '202': description: Waiting on additional data. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfJwtResponse' examples: TOTP Example: description: This value can be used in websites or by devs using sites such as https://jaredwinick.github.io/base64-image-viewer/ and would be scanned by an authenticator app to provide the challenge code. Next please call this same endpoint to verify the MFA registration. value: data: qrCodeUrl: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAeoAAAHqAQAAAADjFjCXAAADHElEQVR42u2dW47bMAxFiXoBXpK27iV5AQY0jsyXkkE/Sg3QoscfRjLx+TEuSF2S0kivXIeAg4ODg4ODg4P/Tbjotd2f9uv53PsZt+1+dL+fa6c92gb+S0oX+P+Jq+qGhkJcQ3/t1F9vbW7dlLj1RKA68IrqXjGsDdVZ1LuvS24Rvm7Pc9fziGoS1YEvU90rmqm4Rq4doc9vqA7852LdI7grp1T/iurAf2Zd91Kd/k1SwGNdB75QdeFh2/n7Gx4WfJHq4noS6RGxzi3Ft4UX3jx4Idbtl7kJK5WY4DzNiqRHiHXgi1Q3hLR3tRRuaR/9jcrJuzp58+A1D6sGdajOiiaRYaNoEpYC1YHX3IQXQ9yvapod2dS6ZONvsepDdeAVN+Gxrr3bh6Gwy3sTkn9FdeAlDxvOQaskGtckGwmtJndiHfgC1anCNi8Va/c1yica8KJyh+rAyx72s936fntUNyBUB77Ew+bGgzVjtWkRHtZqKFSJwRdl2Nzun0La5DCiaYHqwIuqs7yqpToLeI+5PcSdawxDoTrwBR5Wy3KpD3uZ6vyrKhHVga9Y180GNc3X9SkINs+/qA58Raz7GC05dW499u2kLgXrOvD6us4bD7KlCc6pLbGlHgaqAy9nWN+ek6fqXj+32JlocjQlojrwaoY16c2xztLsN19RHXhVdWEQRD9Z+U7kY6MObgJ8iYe1PWIW5kTSRp1m4yY2c8csMfiidZ2VSnLjPy3z9IcthUNUB17zsHNbbBqos/l2l97Oug58SawTV9Pl6zorEHupzvplVE7AV6jOuq+mv9wRy7HO139kWPC66vp0sIlMFeFD8hkBOTHz5sGrGVYk+YU8jOKbEseVjhjjzYP/uZuY9/5PW2G1XxaTJqzrwBefc5I7/aeelZiNrO/lQXXgVdW11POaZtmj8X/4aLFWjlEdeFF1KbjFCXXXNH3X3eayCxt8reraXDRuKeGq4OhNgC8/q3PeN+GH7cT2MOp14IvXdTHLno6/TjsohF3Y4OvP6oy5zWOfqiQ97eWhDwteVx3/IAYcHBwcHBwc/F/HvwBzCfzfcRsB9wAAAABJRU5ErkJggg== challengeId: 01234567890123456789 Email or SMS Example: description: An email will be sent that provides a challenge code. Next please call this same endpoint to verify the MFA registration. If registration is not verified then it will timeout after 10 minutes and will be required again in future authentication calls. value: data: qrCodeUrl: null challengeId: 01234567890123456789 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfString' examples: Agent not found: description: For security unless in debug mode for testing servers the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: No agent found for requested agent name DEF/authAppMFAUse. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid password: description: For security unless in debug mode for testing servers the same error will be returned for multiple credential scenarios. value: errors: - id: null code: nsk-server:Credentials:Failed message: nsk-server:Credentials:Failed type: Error details: null rawMessage: The agent (DEF/authAppMFAUser) failed authentication. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid culture code: description: The provided culture code in the request is an invalid culture identifier. value: errors: - id: null code: nsk:CultureCode:InvalidCultureCode message: The culture code `asdf` is invalid. type: Validation details: null rawMessage: The culture code `asdf` is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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 Culture code not configured: description: The provided culture code in the request is not configured in the resources. For valid culture codes, see GET /api/nsk/v1/resources/cultures value: errors: - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''asdf'' is out of range for ''CultureCodeValidator.Culture Code''.\nExpected values: (en-US,de-DE,en-AU,en-CA,en-IE,es-ES,es-MX,eu-ES,fr-FR,hi-IN,id-ID,ja-JP,ko-KR,th-TH,zh-CN)' type: Validation details: null 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 /api/nsk/v1/token/user/person/singleSignOn: post: tags: - token summary: Creates a new user, links it with a provider, then logs in as the new user. description: 'Warning: This endpoint currently only works with Facebook. If this endpoint fails it could be because an SSO token is already linked to a user or the SSO token is invalid. GraphQL endpoint: singleSignOnUserAdd' operationId: nsk_v1_token_user_person_singleSignOn_post requestBody: x-name: request description: The request for the user to be created. content: application/json: schema: $ref: '#/components/schemas/SingleSignOnCreateRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTokenResponse' /api/nsk/v5/trip: post: tags: - trip summary: Creates a new booking with the provided journeys, contacts, passengers, and SSRs. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: tripCreatev5' operationId: nsk_v5_trip_post parameters: - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\n\ documents' gender. This will update the gender of all the travel documents\ \ in the\npassengers[passengerKey].travelDocuments list in the booking model.\ \ The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 2 requestBody: x-name: request description: The booking sell request. content: application/json: schema: $ref: '#/components/schemas/BookingSellRequest' required: true x-position: 1 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger type not allowed for infant in lap.: description: Example when attempting to add an infant in lap to a passenger type that is not allowed. value: errors: - id: 305fe78c-03e9-4c68-a8f8-5841b5dc6a10 code: nsk:Passenger:PassengerTypeNotAllowedForInfantInLap message: Passenger with type CHD is not allowed to have an infant in lap. type: Validation details: null rawMessage: Passenger with type CHD is not allowed to have an infant in lap. 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 No POST request body.: description: Example when making a call without a request body. value: errors: - id: 5560684d-8fa9-47f1-b2f6-ebe6380d5b69 code: nsk:Exceptions:Null message: An unexpected null value of type 'BookingSellRequest'. type: Validation details: null rawMessage: An unexpected null value of type 'BookingSellRequest'. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v4/trip: post: tags: - trip summary: Creates a new booking with the provided journeys, contacts, passengers, and SSRs. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: tripCreatev4' operationId: nsk_v4_trip_post requestBody: x-name: request description: The booking sell request. content: application/json: schema: $ref: '#/components/schemas/BookingSellRequest' required: true x-position: 1 responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/trip/{legKey}/seats/{unitKey}/properties: get: tags: - trip summary: BETA - Retrieves inventory seat properties for a given flight leg and unit key. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatProperties' operationId: nsk_v1_trip_legKey_seats_unitKey_properties_get parameters: - name: legKey in: path required: true description: The flight leg to retrieve the properties for. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key to retrieve the properties for. schema: type: string x-position: 2 - name: compartmentDesignator in: query description: The compartment to retrieve the seat properties for. schema: type: string nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndListOfInventorySeatPropertyBase' examples: Default: description: '' value: data: tlYhNTY5NSEgITYzODMwMzY4NTAwMDAwMDAwMCFTTEMhREVOITFBIVk-: - code: RECLINER value: 'TRUE' tlYhNTY5NSEgITYzODMwMzY4NTAwMDAwMDAwMCFTTEMhREVOITJBIVk-: - code: AVAILC value: 'TRUE' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'legKey' with value 'X' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null post: tags: - trip summary: BETA - Creates an inventory seat property for a given flight leg and unit key. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatPropertiesAdd' operationId: nsk_v1_trip_legKey_seats_unitKey_properties_post parameters: - name: legKey in: path required: true description: The leg key to modify the properties for. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key to modify the properties for. schema: type: string x-position: 2 requestBody: x-name: property description: The property to create. content: application/json: schema: $ref: '#/components/schemas/InventorySeatPropertyBase' examples: Default: description: The code and value on the request are required and are case-insensitive. value: code: WINDOW value: 'TRUE' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed message: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed type: Error details: null rawMessage: "Inventory seat properties were not committed due\ \ to the following:\r\nCheck if requested property code 'WINDOW'\ \ and value 'TRUE' is an active inventory property in setup.\r\ \nNo inventory seat property to commit." 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 put: tags: - trip summary: BETA - Updates an inventory seat property for a given flight leg and unit key. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatPropertiesSet' operationId: nsk_v1_trip_legKey_seats_unitKey_properties_put parameters: - name: legKey in: path required: true description: The leg key to update the properties for. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key to update the properties for. schema: type: string x-position: 2 requestBody: x-name: property description: The properties to update. content: application/json: schema: $ref: '#/components/schemas/InventorySeatPropertyBase' examples: Default: description: The code and value on the request are required and are case-insensitive. value: code: WINDOW value: 'TRUE' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed message: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed type: Error details: null rawMessage: "Inventory seat properties were not committed due\ \ to the following:\r\nCheck if requested property code 'WINDOW'\ \ and value 'TRUE' is an active inventory property in setup.\r\ \nNo inventory seat property to commit." 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 delete: tags: - trip summary: BETA - Deletes an inventory seat property for a given flight leg and unit key. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatPropertiesDelete' operationId: nsk_v1_trip_legKey_seats_unitKey_properties_delete parameters: - name: legKey in: path required: true description: The leg key to delete the properties for. schema: type: string x-position: 1 - name: unitKey in: path required: true description: The unit key to delete the properties for. schema: type: string x-position: 2 requestBody: x-name: property description: The property to delete. content: application/json: schema: $ref: '#/components/schemas/InventorySeatPropertyBase' examples: Default: description: The code and value on the request are required and are case-insensitive. value: code: WINDOW value: 'TRUE' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed message: nsk:InventorySeatProperties:InventorySeatPropertyCommitFailed type: Error details: null rawMessage: "Inventory seat properties were not committed due\ \ to the following:\r\nCheck if requested property code 'WINDOW'\ \ and value 'TRUE' is an active inventory property in setup.\r\ \nNo inventory seat property to commit." exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/{legKey}/seats/properties: get: tags: - trip summary: BETA - Retrieves inventory seat properties for a given flight leg. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. GraphQL endpoint: inventorySeatPropertiesByLeg' operationId: nsk_v1_trip_legKey_seats_properties_get parameters: - name: legKey in: path required: true description: The flight leg to retrieve the properties for. schema: type: string x-position: 1 - name: compartmentDesignator in: query description: The compartment to retrieve the seat properties for. schema: type: string nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndListOfInventorySeatPropertyBase' examples: Default: description: '' value: data: tlYhNTY5NSEgITYzODMwMzY4NTAwMDAwMDAwMCFTTEMhREVOITFBIVk-: - code: RECLINER value: 'TRUE' tlYhNTY5NSEgITYzODMwMzY4NTAwMDAwMDAwMCFTTEMhREVOITJBIVk-: - code: AVAILC value: 'TRUE' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Default: description: '' value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: null rawMessage: The identifier 'legKey' with value 'X' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/contacts: post: tags: - trip summary: Creates a new contacts-only booking. description: 'This endpoint is not for updating contacts on an existing booking. For that purpose, use the "booking/contacts/{contactTypeCode}" endpoints for PUT and PATCH. This endpoint is to create a new contacts-only booking. An example use case for a contacts-only booking are agency gift certificates (Agency Contact) where a payment is made with the organization credit and left as a credit on the PNR. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: tripContactsAdd' operationId: nsk_v1_trip_contacts_post requestBody: x-name: tripContactsRequest description: The trip contacts request. content: application/json: schema: $ref: '#/components/schemas/TripContactsRequest' examples: Valid trip contacts request: description: Example request for creating a contacts only booking. value: data: contacts: - contactTypeCode: P phoneNumbers: - type: 1 number: '1234' cultureCode: null address: lineOne: '123' lineTwo: null lineThree: null countryCode: null provinceState: null city: City postalCode: '100' emailAddress: mail@mail.com customerNumber: null sourceOrganization: null distributionOption: null notificationPreference: null companyName: null name: first: John middle: null last: Doe title: null suffix: null required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Contacts-only booking: description: Example response for successfully creating a contacts-only booking. value: data: selfServiceMoveAvailable: false bookingKey: null recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: status: 0 paidStatus: 0 priceStatus: 0 profileStatus: 0 bookingType: null channelType: 0 bookedDate: '2026-07-09T05:55:13.5552699+00:00' createdDate: null expirationDate: null modifiedDate: null modifiedAgentId: 0 createdAgentId: 0 owningCarrierCode: null changeAllowed: false createdUserKey: MA-- modifiedUserKey: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: p: contactTypeCode: P phoneNumbers: - type: 1 number: '1234' cultureCode: null address: lineOne: '123' lineTwo: null lineThree: null countryCode: null provinceState: null city: City postalCode: '100' emailAddress: mail@mail.com customerNumber: null sourceOrganization: null distributionOption: null notificationPreference: null companyName: null name: first: John middle: null last: Doe title: null suffix: null passengers: null journeys: null comments: null queues: null history: null payments: null addOns: null orders: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With invalid contact type code: description: The contact type code is invalid or not configured in the system. The list of valid contact type codes can be retrieved using the GET api/nsk/v1/resources/ContactTypes endpoint. value: errors: - id: 12bd2c3d-ddd4-5844-3sz5-3cg52c2e13n1 code: nsk:Contact:InvalidContactTypeCode message: The contact type code 'S' is invalid. type: Validation details: contactTypeCode: S rawMessage: The contact type code 'S' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With duplicate contact type code: description: The contact type code already exists in the request. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Contact:DuplicateTypeCode message: Duplicate contact type 'P' detected. type: Validation details: contactTypeCode: P rawMessage: Duplicate contact type 'P' detected. 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. With no contact type code: description: The contact type code in the request is not populated. value: errors: - id: 5f490eab-3a4d-a783-14ed-25456aecf82f code: Contact.ContactTypeCode:RequiredAttribute message: The Contact field is required. type: Validation details: null rawMessage: The Contact field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With incomplete booking contact information: description: The booking contact information provided is incomplete. value: errors: - id: 666e7592-c107-3812-46e6-f7147dd3c5cd code: nsk-server:BookingContactInfoIncomplete message: Missing or invalid GST Registration Number. type: Validation details: null rawMessage: Missing or invalid GST Registration Number. 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. With booking already in state: description: There is already a booking in state. value: errors: - id: 505b55d3-cac8-93a9-4d25-131256cdd551 code: nsk:Booking:AlreadyExistsInState message: Booking already exists in state. Try again after reseting the state. type: Error details: null rawMessage: Booking already exists in state. Try again after reseting the state. 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. With null request: description: The trip contact request field is null value: errors: - id: 292fcb67-e1de-eb62-3d1a-123a586b03a9 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v2/trip/info: post: tags: - trip summary: Gets the search results for the trip information, based on the search criteria. description: 'This endpoint will return a maximum of 100 journeys. If more than 100 journeys are needed, the search criteria will need to be modified and additional trip calls will need to be made. GraphQL endpoint: tripInformationv2' operationId: nsk_v2_trip_info_post requestBody: x-name: request description: The trip information request. content: application/json: schema: $ref: '#/components/schemas/TripInformationQuery' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationResponsev2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/details: get: tags: - trip summary: Retrieves cabin and various details for the specified leg key. description: 'The additional trip details include the leg cross references, the cabin details (nest counts), and the checkin-lid. GraphQL endpoint: tripInformationDetails' operationId: nsk_v1_trip_info_legKey_details_get parameters: - name: legKey in: path required: true description: The encoded leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTripDetails' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status: patch: tags: - trip summary: Stateless operation for updating the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. An empty string or whitespaces are allowed input values and are not considered as null inputs. Null values will retain the original value in the trip status while empty strings or whitespaces will clear the value from the trip status. When updating tail numbers, this endpoint will not validate mismatching equipment types. If validation is required for tail numbers, please see `POST /equipment/tailNumber`. GraphQL endpoint: tripInformationStatusModify' operationId: nsk_v1_trip_info_legKey_status_patch parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 requestBody: x-name: request description: The trip information status request. content: application/json: schema: $ref: '#/components/schemas/TripInformationStatusRequestBase' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update flight following information successful: description: Example response when flight following information is updated successfully. value: data: null Mismatch tail number equipment type: description: Example response when the tail number is updated even if the equipment type is mismatching. value: messages: - code: nsk:TripStatus:EquipmentTypeMismatch type: Information value: nsk:TripStatus:EquipmentTypeMismatch status: 0 details: flightEquipmentType: '767' tailNumberEquipmentType: '731' data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: null code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. 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 Leg key is invalid: description: Example response when the leg key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'legKey' with value 'NjM4NjY2ODkyMDAwMDAwMTMhICFTTEMhREVOITIzNTk3OTg-' is invalid. type: Validation details: null rawMessage: The identifier 'legKey' with value 'NjM4NjY2ODkyMDAwMDAwMTMhICFTTEMhREVOITIzNTk3OTg-' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Tail number does not exist: description: Example response when the tail number does not exist. See /resources/tailNumbers for the list of all available tail numbers. value: errors: - id: null code: nsk:TripStatus:TailNumberDoesNotExist message: nsk:TripStatus:TailNumberDoesNotExist type: Validation details: tailNumber: abc rawMessage: The tail number does not exist. 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 Tail number exceeds 10 characters: description: Example response when the tail number exceeds 10 characters. value: errors: - id: null code: TripInformationStatusRequestBase.TailNumber:StringLengthAttribute message: The field TripInformationStatusRequestBase must be a string with a maximum length of 10. type: Validation details: validation: StringLengthAttribute model: TripInformationStatusRequestBase member: TailNumber rawMessage: The field TripInformationStatusRequestBase must be a string with a maximum length of 10. 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 Request is null: description: Example response when the request is null. value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/info/{legKey}/status: get: tags: - trip summary: Retrieves the trip status data for the specified leg key. description: 'GraphQL endpoint: tripInformationStatusv2' operationId: nsk_v2_trip_info_legKey_status_get parameters: - name: legKey in: path required: true description: The encoded leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTripStatusv2' examples: Retrieve Trip Status: description: Successfully retrieving the trip status. value: data: tripStatusKey: MzAxMzx2NxFxNCI0MTAxOCBOVjU2MDggU0xDQk8J operationDetails: tailNumber: null equipmentType: '380' equipmentTypeSuffix: '800' status: 0 identifier: identifier: '5608' carrierCode: NV opSuffix: null tripOperationTimes: null counts: boardingCount: 0 boardingSequence: 0 infantCount: 0 nonRevenueCount: 0 revenueCount: 0 checkInCount: 0 fuelOnboardOut: 0 fuelOnboardIn: 0 upLiftFuel: 0 upLiftWeight: 0 cockpitCrewCount: 0 cabinCrewCount: 0 delays: - delayCode: TEST delayMinutes: 10 tripOperationDelayKey: MzAxMzc1MyExMzU1 note: TEST DELAY EDIT createdDate: '2026-07-09T05:55:14.768511Z' includeMvtMessage: true modifiedDate: '2026-07-12T05:55:14.7685353Z' createdUserKey: MQ-- modifiedUserKey: MQ-- payloads: null crewList: null comments: - text: TEST COMMENT EDIT tripOperationCommentKey: MzAxMzc1MyEzMDU4 type: 0 createdDate: '2026-07-09T05:55:14.7686459Z' modifiedDate: '2026-07-12T05:55:14.7686595Z' createdUserKey: MQ-- modifiedUserKey: MQ-- historyList: - tripOperationHistoryKey: MzAxMzc1MyEyODkxNlsz tripOperationHistoryCode: GP detail: US|iAPI Scheduled Msg ( 0/ 0) createdHistoryDate: '2026-07-09T05:55:14.7687139+00:00' - tripOperationHistoryKey: MzAxMzc1EySlOBk2MsN3 tripOperationHistoryCode: GS detail: US|iAPI Scheduled Msg ( 2/ 1) createdHistoryDate: '2026-07-09T05:55:14.7687146+00:00' originDetails: status: 0 note: null gate: null station: SLC destinationDetails: status: 0 note: null baggageClaim: null gate: null station: BOS modifiedAgentName: ExampleAgent verified: true irop: true modifiedDate: '2026-07-09T05:55:14.7687175Z' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/comments: post: tags: - trip summary: Stateless operation for creating operation comments in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationCommentsAdd' operationId: nsk_v1_trip_info_legKey_status_comments_post parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 requestBody: x-name: request description: The trip operation comment create request. content: application/json: schema: $ref: '#/components/schemas/TripOperationCommentCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/info/{legKey}/status/comments/{commentKey}: put: tags: - trip summary: Stateless operation for updating the operation comments in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationCommentsSet' operationId: nsk_v1_trip_info_legKey_status_comments_commentKey_put parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 - name: commentKey in: path required: true description: The key of the comment to be updated. schema: type: string x-position: 2 requestBody: x-name: request description: The trip operation comment request. content: application/json: schema: $ref: '#/components/schemas/TripOperationCommentEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - trip summary: Stateless operation for deleting the operation comments in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationCommentsDelete' operationId: nsk_v1_trip_info_legKey_status_comments_commentKey_delete parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 - name: commentKey in: path required: true description: The key of the comment to be deleted. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/delays: post: tags: - trip summary: Stateless operation for creating operation delays in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationDelaysAdd' operationId: nsk_v1_trip_info_legKey_status_delays_post parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 requestBody: x-name: request description: The trip operation delay request. content: application/json: schema: $ref: '#/components/schemas/TripOperationDelayCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/info/{legKey}/status/delays/{delayKey}: patch: tags: - trip summary: Stateless operation for patching the operation delays in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationDelaysModify' operationId: nsk_v1_trip_info_legKey_status_delays_delayKey_patch parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 - name: delayKey in: path required: true description: The key of the delay to be patched. schema: type: string x-position: 2 requestBody: x-name: request description: The trip operation delay request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTripOperationDelayEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - trip summary: Stateless operation for deleting trip operation delays in the trip information status for a specific flight. description: 'A flight must be within three days of leaving to be able to make flight following information changes. GraphQL endpoint: tripOperationDelaysDelete' operationId: nsk_v1_trip_info_legKey_status_delays_delayKey_delete parameters: - name: legKey in: path required: true description: The leg key of the flight being updated. schema: type: string x-position: 1 - name: delayKey in: path required: true description: The key of the delay to be deleted. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Update Flight Following Information Not Allowed: description: Example response when an agent is not allowed to update the flight following information. value: errors: - id: 7a9504cd-8764-84af-9769-d634a09cd09d code: nsk-server:AuthorizationManageFLIFONotAllowed message: nsk-server:AuthorizationManageFLIFONotAllowed type: Validation details: message: Agent does not have the proper clearance to update FLIFO. rawMessage: Agent does not have the proper clearance to update FLIFO. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/cancel: put: tags: - trip summary: Updates the leg status to cancel. description: 'GraphQL endpoint: modifyStatusCancel' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_cancel_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/closeLeg: put: tags: - trip summary: Updates a leg status closed. description: 'A leg status can be set to closed regardless of check-in configuration period of time set in settings. This check-in restriction determines if a flight can be closed before a designated departure time. It is recommended to set a leg status to close using the check-in restrictions. There are a number of factors that can prevent the leg from being closed. These include: A PNRGOV message is required and has not been sent A flight closure or APIS message is required and has not been sent Passengers have a balance due (unless overrideBalanceDueWarning is specified) Passengers have a balance due and not all passengers on the booking have the same lift status. GraphQL endpoint: updateLegStatusClose' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_closeLeg_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: bypassCheckinRestrictions in: query description: "This will allows updates regardless of checkin configuration\ \ period of time set in settings.\n " schema: type: boolean x-position: 2 - name: overrideBalanceDueWarning in: query description: "This will allow the flight to be closed regardless of any balance\ \ due by any passenger(s) on the leg.\n " schema: type: boolean x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/trip/info/{legKey}/status/operationDetails/status/closeLeg: put: tags: - trip summary: Updates a leg status closed. description: 'A leg status can be set to closed regardless of check-in configuration period of time set in settings. This check-in restriction determines if a flight can be closed before a designated departure time. It is recommended to set a leg status to closed using the check-in restrictions. There are a number of factors that can prevent the leg from being closed. These include: A PNRGOV message is required and has not been sent A flight closure or APIS message is required and has not been sent Passengers have a balance due (unless overrideBalanceDueWarning is specified) Passengers have a balance due and not all passengers on the booking have the same lift status. Exit Row Requirements are not met (unless OverrideExitRowRequirement is specified) GraphQL endpoint: updateLegStatusClosev2' operationId: nsk_v2_trip_info_legKey_status_operationDetails_status_closeLeg_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 requestBody: x-name: request description: "Flight close options.\n " content: application/json: schema: $ref: '#/components/schemas/FlightCloseRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/closePendingLeg: put: tags: - trip summary: Updates a leg status to closed pending. description: 'GraphQL endpoint: updateLegStatusClosePendingv2' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_closePendingLeg_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: overrideExitRowRequirement in: query description: "This will allow the leg to be set to closed pending regardless\ \ of any exit row requirements.\n " schema: type: boolean nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/mishap: put: tags: - trip summary: 'Secures all passenger information associated with the flight leg clearing and locking the passenger data. This changes the leg status to Mishap.' description: 'GraphQL endpoint: modifyStatusMishap' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_mishap_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Flight Key: description: Example of invalid flight key. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'legKey' with value 'aPQxScmtKWMS7YtIi6Pdp9kwUQKLrqc6j9K5f4cM' is invalid. type: Error details: null 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 Update Failed: description: Example of when attempted status change to 'Mishap' failed. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: Attempted update of object 'legKey' has failed. Please verify this object exists. type: Error details: null 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: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/mishapRestore: put: tags: - trip summary: Restores locked passenger data associated with the flight leg. This restores the leg status to normal. description: 'GraphQL endpoint: modifyStatusMishapRestore' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_mishapRestore_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '401': description: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/openLeg: put: tags: - trip summary: Updates a leg status to open. description: 'A leg status can be set to open regardless of checkin configuration period of time set in settings. This checkin restriction determines if a flight can be opened after a designated departure time. It is recommended to set a leg status to open using the checkin restrictions. GraphQL endpoint: updateLegStatusOpen' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_openLeg_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 - name: bypassCheckinRestrictions in: query description: "This will allows updates regardless of checkin configuration\ \ period of time set in settings.\n " schema: type: boolean x-position: 2 - name: convertNoShowToDefault in: query description: If true, converts no show passengers' liftStatus to default schema: type: boolean x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/{legKey}/status/operationDetails/status/restore: put: tags: - trip summary: Updates the leg status to normal. description: 'GraphQL endpoint: modifyStatusRestore' operationId: nsk_v1_trip_info_legKey_status_operationDetails_status_restore_put parameters: - name: legKey in: path required: true description: The leg key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/info/legs: post: tags: - trip summary: Searches for the inventory legs based on the search criteria. description: 'This is functionally a GET but POST is used to reduce URL length overhead. GraphQL endpoint: tripInformationByLegv2' operationId: nsk_v2_trip_info_legs_post requestBody: x-name: request description: The trip information leg query. content: application/json: schema: $ref: '#/components/schemas/TripInformationLegQuery' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationLegv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/info/legs/simple: get: tags: - trip summary: 'Performs a simplified search for trip information by leg, based upon minimal, required data for the search criteria.' description: 'GraphQL endpoint: tripInformationByLegSimplev2' operationId: nsk_v2_trip_info_legs_simple_get parameters: - name: Origin in: query description: "The departure station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 1 - name: Destination in: query description: "The arrival station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: BeginDate in: query description: "The starting date of the trip information search.\n \ \ " schema: type: string format: date-time nullable: true x-position: 3 - name: EndDate in: query description: "The end date of the trip information search.\n " schema: type: string format: date-time nullable: true x-position: 4 - name: StartTimeInterval in: query description: "The starting time of the trip information search.\n \ \ " schema: type: string format: duration nullable: true x-position: 5 - name: EndTimeInterval in: query description: "The end time of the trip information search.\n " schema: type: string format: duration nullable: true x-position: 6 - name: Identifier in: query description: "The transportation identifier, such as a flight number.\n \ \ " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 7 - name: CarrierCode in: query description: "The carrier code.\n " schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 8 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationLegv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/info/simple: get: tags: - trip summary: 'Performs a simplified search for trip information based upon minimal, required data for the search criteria.' description: 'This endpoint will return a maximum of 100 journeys. If more than 100 journeys are needed, the search criteria will need to be modified and additional trip calls will need to be made. GraphQL endpoint: tripInformationSimplev2' operationId: nsk_v2_trip_info_simple_get parameters: - name: NumberOfJourneys in: query description: "When set to null, 100 journeys will be returned.\nThis endpoint\ \ will never return more than 100 journeys.\n " schema: type: integer format: int32 nullable: true x-position: 1 - name: Origin in: query description: "The departure station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: Destination in: query description: "The arrival station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 3 - name: EndDate in: query description: "The end date of the trip information search.\n " schema: type: string format: date-time nullable: true x-position: 4 - name: StartTimeInterval in: query description: "The starting time of the trip information search.\n \ \ " schema: type: string format: duration nullable: true x-position: 5 - name: EndTimeInterval in: query description: "The end time of the trip information search.\n " schema: type: string format: duration nullable: true x-position: 6 - name: CarrierCode in: query description: "The carrier code.\n " schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 7 - name: BeginDate in: query description: "The starting date of the trip information search.\n \ \ " schema: type: string format: date-time nullable: true x-position: 8 - name: Identifier in: query description: "The transportation identifier, such as a flight number.\n \ \ " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 9 - name: FlightType in: query description: "The flight type.\n \nEnumeration values: 0 = All,\ \ 1 = NonStop, 2 = Through, 3 = Direct, 4 = Connect" schema: nullable: true $ref: '#/components/schemas/OperationsFlightType' x-position: 10 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTripInformationResponsev2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/info/status/operationDetails/status/mishapRestore: post: tags: - trip summary: Restores locked passenger data associated the leg information. This restores the leg status to normal. description: 'GraphQL endpoint: modifyStatusRestoreMishap' operationId: nsk_v1_trip_info_status_operationDetails_status_mishapRestore_post requestBody: x-name: request description: The leg key. content: application/json: schema: $ref: '#/components/schemas/MarketInformation' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Unauthorized Agent: description: Example of Agent unauthorized to restore passenger data for restore after mishap. value: errors: - id: null code: nsk:Trip:MishapRestorePassengerDataUnauthorized message: Agent unauthorized to restore passenger data. type: Error details: null 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 Invalid Carrier Code: description: Example of invalid or unknown carrier code. value: errors: - id: null code: nsk:Trip:InvalidCarrierCode message: The carrier code 'x!*' is invalid. type: Error details: null 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 Invalid Origin: description: Example of invalid or unknown departure station. value: errors: - id: null code: nsk:Trip:InvalidOrigin message: The Departure Station 'Gdo' is invalid. type: Error details: null 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 Invalid Destination: description: Example of invalid or unknown arrival station. value: errors: - id: null code: nsk:Trip:InvalidDestination message: The Arrival Station 'hJA' is invalid. type: Error details: null 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 Invalid Flight Number: description: Example of an invalid flight number. value: errors: - id: null code: nsk:Trip:InvalidFlightNumber message: The flight number 'KYB9' is invalid. type: Error details: null 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 Mishap Restore Failed: description: Example of when restoring a flight from mishap failed. value: errors: - id: null code: nsk:Trip:MishapRestoreFailed message: NV1234 was not found or not restored.. type: Error details: null 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: Authentication is required for this request. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/move: post: tags: - trip summary: Moves a journey on the booking in state. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` GraphQL endpoint: movev2' operationId: nsk_v2_trip_move_post requestBody: x-name: request description: Move request. content: application/json: schema: $ref: '#/components/schemas/MoveRequestv2' examples: Move Request: description: Example request for move journey for a booking in state. value: data: fromJourneyKey: TlZ_NTYxMH4gfn5TTEN_MDMvMTcvMjAyNiAxOTowMH5CT1N_MDMvMTcvMjAyNiAyMzo1OX5_ journeyKey: TlZ_NTYxMH4gfn5TTEN_MDMvMTcvMjAyNiAxOTowMH5CT1N_MDMvMTcvMjAyNiAyMzo1OX5_ fareKey: Mn5Cfn5OVn5CRkFSRX4yOTMzfn4wfjB_flg- moveType: 0 ignoreClosedFlightStatus: true ignoreLiftStatus: 2 boardingSequenceOffset: 0 moveSsrOption: 1 standbyPriorityCode: R inventoryControlType: 0 changeReasonCode: 2 required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Journey Key: description: The journey key was not found on the booking in state. value: errors: - id: null code: nsk:Journey:InvalidKey message: nsk:Journey:InvalidKey type: Error details: null rawMessage: Journey key tDiBTmOoPK was not found on the booking in state. 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. With Self Service Move Not Allowed: description: Self-service move is not allowed on the booking. value: errors: - id: null code: nsk:Availability:SelfServiceMoveNotAllowed message: nsk:Availability:SelfServiceMoveNotAllowed type: Error details: null rawMessage: A self-service move is not allowed for this booking. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Trip Move Not Allowed: description: Trip move is not allowed on the initial booking. value: errors: - id: null code: nsk:Trip:MoveNotAllowedOnInitialBooking message: nsk:Trip:MoveNotAllowedOnInitialBooking type: Validation details: null rawMessage: A trip move is not allowed for the initial booking based on the current user's permissions. 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. With Invalid Journey For Confirmed Move Type: description: The original journey is on standby status when attempting to move the trip from confirmed status. value: errors: - id: null code: nsk:Trip:InvalidJourneyForConfirmedMove message: nsk:Trip:InvalidJourneyForConfirmedMove type: Validation details: null rawMessage: The original journey to be moved is invalid because it is on standby status. 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. With No Standby Priority Code: description: The standby priority code is missing when attempting to move the trip to standby status. value: errors: - id: null code: nsk:Trip:StandbyPriorityCodeRequired message: nsk:Trip:StandbyPriorityCodeRequired type: Validation details: null rawMessage: A standby priority code is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Standby Priority Code: description: The provided standby priority code is invalid or not configured in the system. For the list of valid codes, please use the GET /resources/StandByPriorities endpoint. value: errors: - id: null code: nsk:Trip:InvalidStandbyPriorityCode message: nsk:Trip:InvalidStandbyPriorityCode type: Validation details: null rawMessage: The standby priority code tDiBTmOoPK is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Change Reason Code: description: The provided change reason code is invalid or not configured in the system. value: errors: - id: null code: nsk:Trip:InvalidChangeReasonCode message: nsk:Trip:InvalidChangeReasonCode type: Validation details: null rawMessage: The change reason code 8 is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid Split Journey Move: description: The journey does not have at least one boarded and one unboarded segment. value: errors: - id: null code: nsk-server:InvalidSplitJourneyMove message: nsk-server:InvalidSplitJourneyMove type: Error details: null rawMessage: Split Journey requires atleast one boarded and one unboarded segment. 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. With Split Journey Move Not Allowed: description: The user is not allowed to attempt split-journey move. value: errors: - id: null code: nsk-server:InvalidRole message: nsk-server:InvalidRole type: Error details: null rawMessage: Agent is not allowed for SplitJourney. RoleCode = TAW3. 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. With Fly Ahead Move Not Allowed: description: The journey is not enabled for fly-ahead offers. value: errors: - id: null code: nsk-server:InvalidFlyAheadMove message: nsk-server:InvalidFlyAheadMove type: Error details: null rawMessage: 'Fly-ahead move not allowed: Current journey is not enabled for fly-ahead offers' 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. With HIDR Disabled: description: The Hybrid Interline Disruption Recovery premium service is disabled. value: errors: - id: null code: nsk-server:NotHIDREligible message: nsk-server:NotHIDREligible type: Error details: null rawMessage: Not eligible for HIDR move. HIDR is disabled. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v3/trip/move/availability: post: tags: - trip summary: 'Searches for move availability with the full availability search request. This request will allow for total control over the configuration. If a property is not set, the default settings (AvailabilitySettings) is used in its place.' description: 'Note, this is a post request even though it is only getting information. This is due to the complicated data needed in the post data. Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: moveAvailabilityv3' operationId: nsk_v3_trip_move_availability_post requestBody: x-name: request description: The availability move request. content: application/json: schema: $ref: '#/components/schemas/AvailabilityMoveRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '403': description: Role permissions are not met. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v3/trip/move/availability/{journeyKey}: get: tags: - trip summary: 'Searches for availability with the simple move request. The simple search request covers the bare minimum search criteria and lets default settings (AvailabilitySettings) configure the rest.' description: 'Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: moveAvailabilitySimplev3' operationId: nsk_v3_trip_move_availability_journeyKey_get parameters: - name: journeyKey in: path required: true description: The journey key. schema: type: string x-position: 1 - name: BeginDate in: query description: "The departure date.\n " schema: type: string format: date-time nullable: true x-position: 2 - name: Origin in: query description: "The origin station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 3 - name: Destination in: query description: "The destination station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 4 - name: PassengerMoveType in: query description: "The passenger move type.\n \nEnumeration values:\ \ 0 = None, 1 = Irop, 2 = Diversion, 4 = FlightClose, 5 = FlyAhead, 6 =\ \ SplitJourney, 7 = SelfServiceRebooking, 8 = HIDR" schema: $ref: '#/components/schemas/MovePassengerJourneyType' x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/trip/move/availability/selfService: get: tags: - trip summary: Self-service search for move availability. description: 'If no BeginDate is provided, it will default to the journey departure date. If no EndDate is provided, it will default to the begin date + 1 day. Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: moveAvailabilitySelfServicev2' operationId: nsk_v2_trip_move_availability_selfService_get parameters: - name: BeginDate in: query description: "The begin date.\n " schema: type: string format: date-time nullable: true x-position: 1 - name: EndDate in: query description: "The end date.\n " schema: type: string format: date-time nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/move/irop: post: tags: - trip summary: 'Performs an IROP move for the booking in state. This endpoint adds additional IROP move functionality for agents. See `/api/nsk/v2/trip/move` for IROP functionality not restricted to agents only.' description: 'GraphQL endpoint: iropMove' operationId: nsk_v1_trip_move_irop_post requestBody: x-name: request description: IROP move request. content: application/json: schema: $ref: '#/components/schemas/IropMoveRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/passengers: post: tags: - trip summary: Creates a new booking with the provided passengers. description: 'This endpoint is not for updating passengers on an existing booking. For that purpose, use the "booking/passengers/{passengerKey}" endpoints for PUT and PATCH. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: tripPassengersAdd' operationId: nsk_v1_trip_passengers_post parameters: - name: syncPassengerAndTravelDocGender in: query description: "Indicates whether to synchronize the passenger and all its travel\n\ documents' gender. This will update the gender of all the travel documents\ \ in the\npassengers[passengerKey].travelDocuments list in the booking model.\ \ The value defaults to true if not specified.\n " schema: type: boolean default: true x-position: 2 requestBody: x-name: passengerRequests description: The passengers to be added. content: application/json: schema: type: array items: $ref: '#/components/schemas/PassengerRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Valid declared gender mapped to the same binary gender: description: Example response for successfully creating a passenger with a valid declared gender mapped to the same binary gender (i.e. Male to Undisclosed or Unspecified). value: data: selfServiceMoveAvailable: false bookingKey: null recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: status: 0 paidStatus: 0 priceStatus: 0 profileStatus: 0 bookingType: null channelType: 0 bookedDate: '2026-07-09T05:55:13.564119+00:00' createdDate: null expirationDate: null modifiedDate: null modifiedAgentId: 0 createdAgentId: 0 owningCarrierCode: null changeAllowed: false createdUserKey: null modifiedUserKey: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: first: Justine middle: null last: Doe title: null suffix: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: nationality: null residentCountry: null gender: 1 dateOfBirth: '2006-07-09T00:00:00+00:00' familyNumber: null declaredGender: U travelDocuments: null addresses: null weightCategory: 1 emdCoupons: null journeys: null comments: null queues: null history: null payments: null addOns: null orders: null Valid declared gender mapped to a different binary gender: description: Example response for successfully creating a passenger with a valid declared gender mapped to a different binary gender (i.e. Male, Undisclosed or Unspecified to Female). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Male will be synced with Declared Gender value F. New Binary Gender: Female' status: 1 details: null data: selfServiceMoveAvailable: false bookingKey: null recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: status: 0 paidStatus: 0 priceStatus: 0 profileStatus: 0 bookingType: null channelType: 0 bookedDate: '2026-07-09T05:55:13.5641201+00:00' createdDate: null expirationDate: null modifiedDate: null modifiedAgentId: 0 createdAgentId: 0 owningCarrierCode: null changeAllowed: false createdUserKey: null modifiedUserKey: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: first: Justine middle: null last: Doe title: null suffix: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: nationality: null residentCountry: null gender: 2 dateOfBirth: '2006-07-09T00:00:00+00:00' familyNumber: null declaredGender: F travelDocuments: null addresses: null weightCategory: 2 emdCoupons: null journeys: null comments: null queues: null history: null payments: null addOns: null orders: null Mismatching gender and declared gender: description: Example response for successfully creating a passenger with a mismatching gender (Female) and declared gender (Male). value: messages: - code: SyncBinaryGenderToDeclaredGender type: SyncBinaryGenderToDeclaredGender value: 'Passenger Justine Doe - Binary Gender Female will be synced with Declared Gender value M. New Binary Gender: Male' status: 1 details: null data: selfServiceMoveAvailable: false bookingKey: null recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: status: 0 paidStatus: 0 priceStatus: 0 profileStatus: 0 bookingType: null channelType: 0 bookedDate: '2026-07-09T05:55:13.5641213+00:00' createdDate: null expirationDate: null modifiedDate: null modifiedAgentId: 0 createdAgentId: 0 owningCarrierCode: null changeAllowed: false createdUserKey: null modifiedUserKey: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: first: Justine middle: null last: Doe title: null suffix: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: nationality: null residentCountry: null gender: 1 dateOfBirth: '2006-07-09T00:00:00+00:00' familyNumber: null declaredGender: M travelDocuments: null addresses: null weightCategory: 1 emdCoupons: null journeys: null comments: null queues: null history: null payments: null addOns: null orders: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Missing passenger information: description: Example error for missing passenger information. value: errors: - id: null code: nsk-server:PassengerInfoIncomplete message: PassengerInfo is required. type: Error details: null 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 Invalid declared gender length: description: Example response when the declared gender in the request is more than 2 characters. value: errors: - id: null code: PassengerInfo.DeclaredGender:LengthStringAttribute message: The value of PassengerInfo.DeclaredGender:LengthStringAttribute is 'ABC' but must be no more than 2 characters in length. type: Validation details: null rawMessage: The value of PassengerInfo.DeclaredGender:LengthStringAttribute is 'ABC' but must be no more than 2 characters in length. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Inactive or non-existent declared gender: description: Example response when the declared gender in the request is inactive or non-existent. value: errors: - id: null code: nsk-server:InvalidDeclaredGender message: Passenger John Doe has an invalid Declared Gender K. type: Validation details: message: Passenger John Doe has an invalid Declared Gender K. rawMessage: Passenger John Doe has an invalid Declared Gender K. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/trip/passiveSegments: post: tags: - trip summary: Creates a passive segment and creates a booking if it doesn't already exist. description: 'This endpoint creates a new journey with the passive segment on it. A passive segment cannot be updated, however get and delete work like all other journeys. IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: tripPassiveSegmentAdd' operationId: nsk_v1_trip_passiveSegments_post requestBody: x-name: request description: The passive segment request. content: application/json: schema: $ref: '#/components/schemas/PassiveSegmentRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v5/trip/rebook/availability: post: tags: - trip summary: Rebook search with the current booking defaults. description: 'Requires a booking in state. Although this endpoint behaves like a GET, POST is used to reduce the limitations resulting from URL length issues. GraphQL endpoint: rebookAvailabilityv5' operationId: nsk_v5_trip_rebook_availability_post requestBody: x-name: request description: The rebook request. content: application/json: schema: $ref: '#/components/schemas/AvailabilityRebookRequestv3' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v4/trip/rebook/availability/simple: get: tags: - trip summary: Simple rebook search with the current booking defaults. description: 'Requires a booking in state. The AvailabilityCriteriaFilter.FareInclusionType.NoPricing enumeration value, if set, will result in an availability response that does not include fares. The primary use case for this is in Move flows, but is being maintained on the main availability and rebook availability flows in case there are other use cases as well. Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: rebookAvailabilitySimplev4' operationId: nsk_v4_trip_rebook_availability_simple_get parameters: - name: Origin in: query description: "The origin station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 1 - name: Destination in: query description: "The destination station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 2 - name: BeginDate in: query description: "The departure date.\n " schema: type: string format: date-time x-position: 3 - name: EndDate in: query description: "The return date if this is a round trip request.\n \ \ " schema: type: string format: date-time nullable: true x-position: 4 - name: LoyaltyFilter in: query description: "The loyalty fare filter.\n \nEnumeration values:\ \ 0 = MonetaryOnly, 1 = PointsOnly, 2 = PointsAndMonetary, 3 = PreserveCurrent" schema: nullable: true $ref: '#/components/schemas/LoyaltyFilter' x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/schedule: get: tags: - trip summary: Retrieves the schedule of flights for a market. description: 'GraphQL endpoint: tripScheduleSimple' operationId: nsk_v1_trip_schedule_get parameters: - name: Origin in: query description: "The origin station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 1 - name: Destination in: query description: "The destination station code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 2 - name: BeginDate in: query description: "The begin date to search for.\n " schema: type: string format: date-time x-position: 3 - name: EndDate in: query description: "The end date to search for.\n " schema: type: string format: date-time x-position: 4 - name: Type in: query description: "The flight type filter.\n \nEnumeration values:\ \ 0 = None, 1 = NonStop, 2 = Through, 3 = Direct, 4 = Connect, 5 = All" schema: nullable: true $ref: '#/components/schemas/FlightType' x-position: 5 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfScheduleDetail' /api/nsk/v1/trip/schedule/adHoc: post: tags: - trip summary: Creates an ad hoc flight. description: 'GraphQL endpoint: tripScheduleAdHocAdd' operationId: nsk_v1_trip_schedule_adHoc_post requestBody: x-name: request description: The commit itinerary variation request. content: application/json: schema: $ref: '#/components/schemas/CommitItineraryVariationRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfItineraryVariation' /api/nsk/v4/trip/sell: post: tags: - trip summary: Sells the list of journeys and creates a booking if it doesn't already exist. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` This endpoint will ignore the contents of ''TripSellRequestv2.Passengers.Types.Details'' if there are already passengers in the booking in state and use the existing passengers instead. GraphQL endpoint: tripAddv5' operationId: nsk_v4_trip_sell_post requestBody: x-name: request description: The trip sell request. content: application/json: schema: $ref: '#/components/schemas/TripSellRequestv2' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBooking' examples: Trip sold successfully.: description: Example response when the trip is sold successfully. value: data: selfServiceMoveAvailable: false bookingKey: MyE2dWp4ZSFmYWxzZQ-- recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: null travelDocuments: null addresses: - status: 0 companyName: null lineOne: 123 First Street passengerAddressKey: null phone: 555-555-1234 lineTwo: null stationCode: SLC lineThree: null emailAddress: null countryCode: US cultureCode: null provinceState: UT refusedContact: null city: SLC postalCode: '84108' weightCategory: null emdCoupons: null journeys: - flightType: 1 stops: 0 designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' move: null segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' isSeatmapViewable: true fares: - isGoverning: true carrierCode: null fareKey: MH5Cfn5OVn5CRU1EfkVTQ1J_fjB_MH5_WA-- classOfService: null classType: null fareApplicationType: 0 fareClassOfService: null fareBasisCode: null fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: null ruleNumber: null productClass: null ruleTariff: null travelClassCode: null pricingDate: '0001-01-01T00:00:00' crossReferenceClassOfService: null fareDesignator: null passengerFares: null fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '1234' carrierCode: NV opSuffix: null passengerSegment: mcfbrfQ-: seats: null passengerKey: null activityDate: null boardingSequence: null createdDate: null liftStatus: 2 modifiedDate: null overBookIndicator: 0 priorityDate: null timeChanged: false verifiedTravelDocs: null sourcePointOfSale: null pointOfSale: null ssrs: - isConfirmed: false isConfirmingUnheld: false note: null ssrDuration: 0 ssrKey: null count: 0 ssrCode: WCHR feeCode: null inBundle: false passengerKey: null ssrDetail: null ssrNumber: null market: null tickets: null bags: null scores: null boardingPassDetail: null hasInfant: false seatPreferences: null bundleCode: null verifiedTravelDocuments: null referenceNumber: 0 baggageGroupNumber: null baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 0 cabinOfService: null externalIdentifier: null priorityCode: null changeReasonCode: 0 segmentType: 0 salesDate: null international: false flightReference: null legs: - legKey: null operationsInfo: null designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' legInfo: null nests: null ssrs: null seatmapReference: null flightReference: null status: 0 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: null queues: null history: null payments: null addOns: null orders: null PaxPriceDetails are ignored.: description: Example message when there are already existing booking passengers and the Passengers.Types. The trip is sold successfully and the details in the request are ignored. value: messages: - code: nsk:Trip:PaxPriceDetailsRequestIgnored type: Warning value: The contents of 'TripSellRequestv2.Passengers.Types.Details' are ignored because the booking in state already contains passengers. status: 0 details: null data: selfServiceMoveAvailable: false bookingKey: MyE2dWp4ZSFmYWxzZQ-- recordLocator: null currencyCode: null systemCode: null groupName: null locators: null info: null sales: null typeOfSale: null hold: null breakdown: null receivedBy: null contacts: null passengers: mcfbrfQ-: passengerKey: MCFBRFQ- passengerAlternateKey: null customerNumber: null fees: null name: null passengerTypeCode: ADT discountCode: null bags: null program: null infant: null info: null travelDocuments: null addresses: - status: 0 companyName: null lineOne: 123 First Street passengerAddressKey: null phone: 555-555-1234 lineTwo: null stationCode: SLC lineThree: null emailAddress: null countryCode: US cultureCode: null provinceState: UT refusedContact: null city: SLC postalCode: '84108' weightCategory: null emdCoupons: null journeys: - flightType: 1 stops: 0 designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' move: null segments: - isStandby: false isConfirming: false isConfirmingExternal: false isBlocked: false isHosted: true isChangeOfGauge: false designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' isSeatmapViewable: true fares: - isGoverning: true carrierCode: null fareKey: MH5Cfn5OVn5CRU1EfkVTQ1J_fjB_MH5_WA-- classOfService: null classType: null fareApplicationType: 0 fareClassOfService: null fareBasisCode: null fareSequence: 0 inboundOutBound: 0 fareStatus: 0 isAllotmentMarketFare: false originalClassOfService: null ruleNumber: null productClass: null ruleTariff: null travelClassCode: null pricingDate: '0001-01-01T00:00:00' crossReferenceClassOfService: null fareDesignator: null passengerFares: null fareLink: 0 segmentKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ identifier: identifier: '1234' carrierCode: NV opSuffix: null passengerSegment: mcfbrfQ-: seats: null passengerKey: null activityDate: null boardingSequence: null createdDate: null liftStatus: 2 modifiedDate: null overBookIndicator: 0 priorityDate: null timeChanged: false verifiedTravelDocs: null sourcePointOfSale: null pointOfSale: null ssrs: - isConfirmed: false isConfirmingUnheld: false note: null ssrDuration: 0 ssrKey: null count: 0 ssrCode: WCHR feeCode: null inBundle: false passengerKey: null ssrDetail: null ssrNumber: null market: null tickets: null bags: null scores: null boardingPassDetail: null hasInfant: false seatPreferences: null bundleCode: null verifiedTravelDocuments: null referenceNumber: 0 baggageGroupNumber: null baggageAllowanceUsed: false baggageAllowanceWeight: 0 baggageAllowanceWeightType: 0 stayType: 0 infantStayType: 0 channelType: 0 cabinOfService: null externalIdentifier: null priorityCode: null changeReasonCode: 0 segmentType: 0 salesDate: null international: false flightReference: null legs: - legKey: null operationsInfo: null designator: destination: DEN origin: SLC arrival: '2026-07-10T00:00:00+00:00' departure: '2026-07-09T00:00:00+00:00' legInfo: null nests: null ssrs: null seatmapReference: null flightReference: null status: 0 journeyKey: TlZ_NTY3MH4gfn5TTEN_MDEvMzEvMjAyNSAxNzozMH5CT1N_MDEvMzEvMjAyNSAyMzozMH5_ notForGeneralUser: false comments: null queues: null history: null payments: null addOns: null orders: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/trip/standby/availability: post: tags: - trip summary: Retrieves same-day standby availability relevant to the current state booking. description: 'This endpoint only provisions same-day standby availability. The existing, standard flight availability endpoints should still be used for other standby availability search scenarios. Although this endpoint behaves like a GET, POST reduces the limitations resulting from URL length issues. Even though service bundle offers is part of the endpoint response, it is expected to be not populated. GraphQL endpoint: tripStandbyAvailability' operationId: nsk_v1_trip_standby_availability_post requestBody: x-name: request description: The standby availability request to use in the search. content: application/json: schema: $ref: '#/components/schemas/AvailabilityStandbyRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAvailabilityv2' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/user: get: tags: - user summary: Retrieves the current logged in user. description: 'GraphQL endpoint: user' operationId: nsk_v1_user_get responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfUser' deprecated: true post: tags: - user summary: Creates a user and person (used by anonymous to create non agent logins). description: 'This endpoint will create a user based off the system configured customer creation parameters. The associated person has to be of type customer or an exception will be thrown. To change these default settings please configure utilities. GraphQL endpoint: userAdd' operationId: nsk_v1_user_post requestBody: x-name: request description: The user customer create request. content: application/json: schema: $ref: '#/components/schemas/UserCustomerCreateRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - user summary: Updates the current logged in user. description: 'GraphQL endpoint: userSet' operationId: nsk_v1_user_put requestBody: x-name: request description: The user edit request. content: application/json: schema: $ref: '#/components/schemas/UserRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true patch: tags: - user summary: Patches the current logged in user. description: 'GraphQL endpoint: userModifyv2' operationId: nsk_v1_user_patch requestBody: x-name: request description: The user patch request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfUserRequest' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/user/bookings: get: tags: - user summary: Searches the logged in user booking upcoming and past bookings. description: 'GraphQL endpoint: userBookings' operationId: nsk_v1_user_bookings_get parameters: - name: AssociatedFirstName in: query description: "An associated passenger/contact first name.\n " schema: type: string nullable: true x-position: 1 - name: AssociatedLastName in: query description: "An associated passenger/contact last name.\n " schema: type: string nullable: true x-position: 2 - name: PhoneticSearch in: query description: "Flag indicating to search using the phonetic option.\n \ \ " schema: type: boolean nullable: true x-position: 3 - name: TripIdentifier in: query description: "Filter by trip identifier.\n " schema: type: string nullable: true x-position: 4 - name: Origin in: query description: "Filter by origin station code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 5 - name: Destination in: query description: "Filter by destination station code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 6 - name: SearchArchive in: query description: "Flag indicating to search archived bookings.\n " schema: type: boolean nullable: true x-position: 7 - name: TripDate in: query description: "Filter by trip date.\n " schema: type: string format: date-time nullable: true x-position: 8 - name: StartDate in: query description: "Filter by starting search date.\n " schema: type: string format: date-time nullable: true x-position: 9 - name: EndDate in: query description: "Filter by ending search date.\n " schema: type: string format: date-time nullable: true x-position: 10 - name: SearchByCustomerNumber in: query description: "Flag indicating to search by the users customer number instead\ \ of user identifier.\n " schema: type: boolean nullable: true x-position: 11 - name: ReturnCount in: query description: "The number of results to be returned.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 x-position: 12 - name: LastBookingKey in: query description: "The last booking key.\n " schema: type: string nullable: true x-position: 13 - name: StartingIndex in: query description: "The starting index of the next set of bookings (used for paging).\n\ \ " schema: type: integer format: int64 nullable: true x-position: 14 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' deprecated: true /api/nsk/v1/user/bookingsByContactCustomerNumber: get: tags: - user summary: Searches for any bookings that have the current user as a contact via their customer number. description: 'GraphQL endpoint: userBookingsByContactCustomerNumber' operationId: nsk_v1_user_bookingsByContactCustomerNumber_get parameters: - name: PageSize in: query description: "The number of items to return for the request.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 1 - name: LastIndex in: query description: "The last booking index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 2 - name: FlightNumber in: query description: "Filter by the flight number.\n " schema: type: string nullable: true x-position: 3 - name: DepartureDate in: query description: "The first journeys departure date.\n " schema: type: string format: date-time nullable: true x-position: 4 - name: Destination in: query description: "Filter by the destination code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 5 - name: Origin in: query description: "Filter by the departure code.\n " schema: type: string maxLength: 3 minLength: 3 nullable: true x-position: 6 - name: SourceOrganization in: query description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n " schema: type: string maxLength: 10 minLength: 0 nullable: true x-position: 7 - name: OrganizationGroupCode in: query description: "Filter by the organization group code to find.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 8 - name: SearchArchive in: query description: "Whether or not to search the booking archive.\n " schema: type: boolean nullable: true x-position: 9 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' /api/nsk/v1/user/bookingsByPassenger: get: tags: - user summary: Searches the logged in user booking upcoming and past bookings. description: 'This is similar to the user booking endpoint but returns more focused trip information. This endpoint will only return data where a booking''s passenger customer number matches the current logged in user. Bookings made by the user where the passenger customer number is not assigned are ignored. The BeginDate will default to today, and the EndDate defaults to one month from today unless a value is provided. GraphQL endpoint: userBookingsByPassenger' operationId: nsk_v1_user_bookingsByPassenger_get parameters: - name: StartDate in: query description: "Booking start search date.\n " schema: type: string format: date-time nullable: true x-position: 1 - name: EndDate in: query description: "Booking end search date.\n " schema: type: string format: date-time nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingTripResult' deprecated: true /api/nsk/v1/user/impersonate: get: tags: - user summary: Gets the logged in users current session roles state. description: 'GraphQL endpoint: impersonate' operationId: nsk_v1_user_impersonate_get responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNskRoles' post: tags: - user summary: Impersonates a new role for the logged in user. description: 'GraphQL endpoint: impersonateSet' operationId: nsk_v1_user_impersonate_post requestBody: x-name: request description: The user impersonate request. content: application/json: schema: $ref: '#/components/schemas/UserImpersonateRequest' required: true x-position: 1 responses: '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - user summary: Resets the logged in users role. description: 'GraphQL endpoint: impersonateDelete' operationId: nsk_v1_user_impersonate_delete responses: '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Success.: description: Success will return a 200 with no data. value: data: null Not impersonating.: description: If not needed a 200 will be returned with a warning. value: messages: - code: nsk:NoOperation type: Warning value: No operation was performed. The data is already in the expected state. status: 0 details: null data: null /api/nsk/v3/user/password/change: post: tags: - user summary: Changes the logged in user's password. description: 'Validates that the current password is correct before proceeding. This follows domain level restrictions and could result in a failed change if there is a minimum time requirement between password changes, invalid password length, or invalid character. GraphQL endpoint: userChangePasswordv3' operationId: nsk_v3_user_password_change_post requestBody: x-name: request description: The change password request. content: application/json: schema: $ref: '#/components/schemas/UserChangePasswordRequestv2' examples: UserChangePasswordRequestv2: description: Updates the current user's password with the new provided one. value: currentPassword: oldPassword123! newPassword: newPassword123! required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Error response for incorrect domain, username, or password.: description: Only returns raw message in debug mode. value: errors: - id: null code: nsk:PasswordChange:Failed message: null type: Error details: null rawMessage: 'nsk-server:AgentAuthentication: The agent (WWW/ABC123) was not authenticated' 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 Error response for a locked account.: description: Only returns raw message in debug mode. value: errors: - id: null code: nsk:PasswordChange:Failed message: null type: Error details: null rawMessage: 'nsk-server:AgentLocked: The agent (WWW/ABC123) is locked.' 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 Error response for minimum password time.: description: Only returns raw message in debug mode. Minimum time is determined by domain configuration. value: errors: - id: null code: nsk:PasswordChange:Failed message: null type: Error details: null rawMessage: 'nsk-server:PasswordMinimumTime: The agent (WWW/ABC123) cannot change their password before the Minimum Time is up.' 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 Error response for password policy violation.: description: Only returns raw message in debug mode. Password policy is configurable and determined by the domain. value: errors: - id: null code: nsk:PasswordChange:Failed message: null type: Error details: null rawMessage: 'nsk-server:PasswordPolicy: X, Y, Z' 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 Error response when the new password is already used as password before.: description: Only returns raw message in debug mode. Unique password count is determined by domain configuration. value: errors: - id: null code: nsk-server:PasswordHistory message: nsk-server:PasswordHistory type: Information details: null rawMessage: The agent (WWW/tst01) cannot reuse this password. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/user/preferences/skySpeedSettings: get: tags: - user summary: Retrieves the default SkySpeed settings user preferences of the currently logged in user. description: 'GraphQL endpoint: userPreferencesSkySpeedSettings' operationId: nsk_v1_user_preferences_skySpeedSettings_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSkySpeedSettingsUserPreferences' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true put: tags: - user summary: Updates the default SkySpeed settings user preferences of the currently logged in user. description: 'If the SkySpeed settings of the current user is disabled and an update is made, the settings will automatically be enabled and updated. If given, each string property is validated if it exists and is active. The collection currency setting can only be CollectionCurrencySetting.None if the collection currency code is null or empty. A bad request will be returned if the collection currency code and collection currency setting are: - Collection Currency Code is not null or empty and the Collection Currency Setting is set to CollectionCurrency.None. - Collection Currency Code is null or empty and the Collection Currency Setting is set to CollectionCurrency.Both (Any value except for CollectionCurrencySetting.None). GraphQL endpoint: userPreferencesSkySpeedSettingsSet' operationId: nsk_v1_user_preferences_skySpeedSettings_put requestBody: x-name: request description: The SkySpeed settings user preferences. content: application/json: schema: $ref: '#/components/schemas/SkySpeedSettingsUserPreferences' required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/user/roles: get: tags: - user summary: Gets all roles from the logged in user. description: Gets all roles from the logged in user. operationId: nsk_v1_user_roles_get responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfUserRole' deprecated: true post: tags: - user summary: Creates a new role on the logged in user. description: 'GraphQL endpoint: userRoleAdd' operationId: nsk_v1_user_roles_post requestBody: x-name: request description: The new role. content: application/json: schema: $ref: '#/components/schemas/UserRoleCreateRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/user/roles/{userRoleKey}: get: tags: - user summary: Gets a specific role from the logged in user. description: 'GraphQL endpoint: userRole' operationId: nsk_v1_user_roles_userRoleKey_get parameters: - name: userRoleKey in: path required: true description: The unique user role key schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfUserRole' deprecated: true put: tags: - user summary: Updates a specific role on the logged in user. description: 'GraphQL endpoint: userRoleSet' operationId: nsk_v1_user_roles_userRoleKey_put parameters: - name: userRoleKey in: path required: true description: The unique user role key. schema: type: string x-position: 1 requestBody: x-name: request description: The modified role. content: application/json: schema: $ref: '#/components/schemas/UserRoleEditRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true patch: tags: - user summary: Patches a specific role on the logged in user. description: 'GraphQL endpoint: userRoleModify' operationId: nsk_v1_user_roles_userRoleKey_patch parameters: - name: userRoleKey in: path required: true description: The unique user role key. schema: type: string x-position: 1 requestBody: x-name: request description: The patched role. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfUserRolePatchRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true delete: tags: - user summary: Deletes a specific role on the logged in user. description: 'GraphQL endpoint: userRoleDelete' operationId: nsk_v1_user_roles_userRoleKey_delete parameters: - name: userRoleKey in: path required: true description: The unique user role key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v1/user/singleSignOnToken: get: tags: - user summary: Gets all of the single sign on tokens associated with a specific user. description: 'GraphQL endpoint: singleSignOnTokens' operationId: nsk_v1_user_singleSignOnToken_get responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfUserSingleSignOnToken' /api/nsk/v1/user/singleSignOnToken/{providerKey}: get: tags: - user summary: Gets a single sign on token associated with a specific user. description: 'GraphQL endpoint: singleSignOnToken' operationId: nsk_v1_user_singleSignOnToken_providerKey_get parameters: - name: providerKey in: path required: true description: The single sign on provider key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfUserSingleSignOnToken' post: tags: - user summary: Links the requested token with the logged-in user. description: 'GraphQL endpoint: singleSignOnTokenAdd' operationId: nsk_v1_user_singleSignOnToken_providerKey_post parameters: - name: providerKey in: path required: true description: The single sign on provider key. schema: type: string x-position: 1 requestBody: x-name: tokenRequest description: The single sign on token request. content: application/json: schema: $ref: '#/components/schemas/SingleSignOnTokenRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - user summary: Updates an existing token associated with the logged-in user. description: 'GraphQL endpoint: singleSignOnTokenSet' operationId: nsk_v1_user_singleSignOnToken_providerKey_put parameters: - name: providerKey in: path required: true description: The single sign on provider key. schema: type: string x-position: 1 requestBody: x-name: tokenRequest description: The single sign on token request. content: application/json: schema: $ref: '#/components/schemas/SingleSignOnTokenRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - user summary: Patches an existing token associated with the logged-in user. description: 'GraphQL endpoint: singleSignOnTokenModify' operationId: nsk_v1_user_singleSignOnToken_providerKey_patch parameters: - name: providerKey in: path required: true description: The single sign on provider key. schema: type: string x-position: 1 requestBody: x-name: tokenRequest description: The single sign on token request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfSingleSignOnTokenRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - user summary: Deletes a token associated with the single sign on provider from the logged-in user. description: 'GraphQL endpoint: singleSignOnTokenDelete' operationId: nsk_v1_user_singleSignOnToken_providerKey_delete parameters: - name: providerKey in: path required: true description: The single sign on provider key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users: post: tags: - users summary: Creates a new user and person (used by agents to create other users). description: 'This method is used by agents to create other users (either agents or customers). Use this method when you want to create both a user and a person at the same time. GraphQL endpoint: usersAdd' operationId: nsk_v1_users_post requestBody: x-name: request description: The new user request. content: application/json: schema: $ref: '#/components/schemas/UserCreateRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Duplicate Agent Name: description: The agent name already exists. value: errors: - id: 5d7a5d1c-d481-9723-260d-59f53b861112 code: nsk:User:UserNameAlreadyExists message: Agent name 'firstAgent' already exists. type: Information details: null rawMessage: Agent name 'firstAgent' already exists. 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. With Non-Existent Organization: description: The organization is not found on the server. value: errors: - id: 17df744c-6115-9771-9151-5e9faa488e44 code: nsk-server:OrganizationNotFound message: The requested organization was not found. Organization ID = '0999' type: Information details: null rawMessage: The requested organization was not found. Organization ID = '0999' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v2/users: get: tags: - users summary: Search user records. description: 'GraphQL endpoint: usersv2' operationId: nsk_v2_users_get parameters: - name: OrganizationCode in: query description: "The organization code to search by.\n " schema: type: string nullable: true x-position: 1 - name: LocationGroupCode in: query description: "The location group code to search by.\n " schema: type: string nullable: true x-position: 2 - name: DomainCode in: query description: "The domain code to search in.\n " schema: type: string nullable: true x-position: 3 - name: Username in: query description: "The unique username to search by.\n " schema: type: string nullable: true x-position: 4 - name: UsernameMatching in: query description: "The matching criteria for the username.\n \nEnumeration\ \ values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 5 - name: FirstName in: query description: "The agent's first name to search by.\n " schema: type: string nullable: true x-position: 6 - name: FirstNameMatching in: query description: "The matching criteria for the agent's first name.\n \ \ \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains,\ \ 3 = ExactMatch" schema: nullable: true $ref: '#/components/schemas/MatchCriteria' x-position: 7 - name: LastName in: query description: "The agent's last name to search by.\n " schema: type: string nullable: true x-position: 8 - name: RoleCode in: query description: "The role code to search with.\n " schema: type: string nullable: true x-position: 9 - name: Status in: query description: "The agent status to search by.\n \nEnumeration values:\ \ 0 = Default, 1 = Active, 2 = Pending, 3 = Suspended, 4 = Terminated" schema: nullable: true $ref: '#/components/schemas/UserStatus' x-position: 10 - name: ReturnCount in: query description: "The number of results to return.\n " schema: type: integer nullable: true x-position: 11 - name: LastIndex in: query description: "The last user index (used for paging).\n " schema: type: integer format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true x-position: 12 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfUserRecord' post: tags: - users summary: Creates a new user for a person (used by agents to create other users). description: 'This method is used by agents to create other users (either agents or customers) and connect them with an existing person. Use this method when a person already exists and you want to create a user for them. GraphQL endpoint: usersAddV2' operationId: nsk_v2_users_post requestBody: x-name: request description: The request for the user to be created. content: application/json: schema: $ref: '#/components/schemas/UserCreateRequestv2' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Duplicate Agent Name: description: The agent name already exists. value: errors: - id: 5d7a5d1c-d481-9723-260d-59f53b861112 code: nsk:User:UserNameAlreadyExists message: Agent name 'firstAgent' already exists. type: Information details: null rawMessage: Agent name 'firstAgent' already exists. 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. With Non-Existent Organization: description: The organization is not found on the server. value: errors: - id: 17df744c-6115-9771-9151-5e9faa488e44 code: nsk-server:OrganizationNotFound message: The requested organization was not found. Organization ID = '0999' type: Information details: null rawMessage: The requested organization was not found. Organization ID = '0999' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v1/users/{userKey}: get: tags: - users summary: Retrieves the a specific user. description: 'GraphQL endpoint: users' operationId: nsk_v1_users_userKey_get parameters: - name: userKey in: path required: true description: The user key of the user to retrieve. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfUser' put: tags: - users summary: Updates the specific user. description: 'GraphQL endpoint: usersSet' operationId: nsk_v1_users_userKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The user edit request. content: application/json: schema: $ref: '#/components/schemas/UserRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Duplicate Agent Name: description: The agent name already exists. value: errors: - id: 5d7a5d1c-d481-9723-260d-59f53b861112 code: nsk:User:UserNameAlreadyExists message: Agent name 'firstAgent' already exists. type: Information details: null rawMessage: Agent name 'firstAgent' already exists. 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. With Non-Existent Organization: description: The organization is not found on the server. value: errors: - id: 17df744c-6115-9771-9151-5e9faa488e44 code: nsk-server:OrganizationNotFound message: The requested organization was not found. Organization ID = '0999' type: Information details: null rawMessage: The requested organization was not found. Organization ID = '0999' 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. '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches the current logged in user. description: 'GraphQL endpoint: usersModifyv2' operationId: nsk_v1_users_userKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The user patch request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfUserRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Duplicate Agent Name: description: The agent name already exists. value: errors: - id: 5d7a5d1c-d481-9723-260d-59f53b861112 code: nsk:User:UserNameAlreadyExists message: Agent name 'firstAgent' already exists. type: Information details: null rawMessage: Agent name 'firstAgent' already exists. 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. With Non-Existent Organization: description: The organization is not found on the server. value: errors: - id: 17df744c-6115-9771-9151-5e9faa488e44 code: nsk-server:OrganizationNotFound message: The requested organization was not found. Organization ID = '0999' type: Information details: null rawMessage: The requested organization was not found. Organization ID = '0999' 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. '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Delete the user. description: 'This is a soft delete by setting the user record status to terminated. GraphQL endpoint: usersDelete' operationId: nsk_v1_users_userKey_delete parameters: - name: userKey in: path required: true description: User key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/bookings: get: tags: - users summary: Searches the specific user for upcoming and past bookings. description: 'GraphQL endpoint: usersBookingsv2' operationId: nsk_v1_users_userKey_bookings_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: AssociatedFirstName in: query description: "An associated passenger/contact first name.\n " schema: type: string nullable: true x-position: 2 - name: AssociatedLastName in: query description: "An associated passenger/contact last name.\n " schema: type: string nullable: true x-position: 3 - name: PhoneticSearch in: query description: "Flag indicating to search using the phonetic option.\n \ \ " schema: type: boolean nullable: true x-position: 4 - name: TripIdentifier in: query description: "Filter by trip identifier.\n " schema: type: string nullable: true x-position: 5 - name: Origin in: query description: "Filter by origin station code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 6 - name: Destination in: query description: "Filter by destination station code.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 7 - name: SearchArchive in: query description: "Flag indicating to search archived bookings.\n " schema: type: boolean nullable: true x-position: 8 - name: TripDate in: query description: "Filter by trip date.\n " schema: type: string format: date-time nullable: true x-position: 9 - name: StartDate in: query description: "Filter by starting search date.\n " schema: type: string format: date-time nullable: true x-position: 10 - name: EndDate in: query description: "Filter by ending search date.\n " schema: type: string format: date-time nullable: true x-position: 11 - name: SearchByCustomerNumber in: query description: "Flag indicating to search by the users customer number instead\ \ of user identifier.\n " schema: type: boolean nullable: true x-position: 12 - name: ReturnCount in: query description: "The number of results to be returned.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 x-position: 13 - name: LastBookingKey in: query description: "The last booking key.\n " schema: type: string nullable: true x-position: 14 - name: StartingIndex in: query description: "The starting index of the next set of bookings (used for paging).\n\ \ " schema: type: integer format: int64 nullable: true x-position: 15 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingSearchResult' /api/nsk/v1/users/{userKey}/bookingsByPassenger: get: tags: - users summary: Searches the specific user upcoming and past bookings by passenger. description: 'This is similar to the user booking endpoint but returns more focused trip information. This endpoint will only return data where a bookings passenger customer number matches the current logged in user. Bookings made by the user but where the passenger customer are not assigned are ignored. The BeginDate will default to today, and the EndDate defaults to one month from today unless a value is provided. GraphQL endpoint: usersBookingsByPassenger' operationId: nsk_v1_users_userKey_bookingsByPassenger_get parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: StartDate in: query description: "Booking start search date.\n " schema: type: string format: date-time nullable: true x-position: 2 - name: EndDate in: query description: "Booking end search date.\n " schema: type: string format: date-time nullable: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBookingTripResult' /api/nsk/v1/users/{userKey}/password/change: post: tags: - users summary: Changes a specifics user's password. description: 'Requires agent permissions. GraphQL endpoint: usersChangePassword' operationId: nsk_v1_users_userKey_password_change_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The change password request. content: application/json: schema: $ref: '#/components/schemas/UserChangePasswordRequestBase' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/password/reset: post: tags: - users summary: Invokes the forgot password reset for a specific user. description: 'Requires agent permissions. GraphQL endpoint: usersForgotPassword' operationId: nsk_v1_users_userKey_password_reset_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '202': description: The request was accepted successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person: get: tags: - users summary: Retrieves the specific user's person. description: 'GraphQL endpoint: usersPerson' operationId: nsk_v1_users_userKey_person_get parameters: - name: userKey in: path required: true description: The user key of the person record to retrieve. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPerson' put: tags: - users summary: Updates the specific user's person record basic information. description: 'GraphQL endpoint: usersPersonSet' operationId: nsk_v1_users_userKey_person_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The person edit request. content: application/json: schema: $ref: '#/components/schemas/PersonEditRequest' examples: Person Edit Request: description: Example request for updating person's basic information. value: name: first: John middle: Cee last: Doe title: Mr. suffix: null type: 1 status: 0 details: gender: 1 dateOfBirth: '2006-07-09T05:55:15.829325+00:00' nationality: US residentCountry: US passengerType: ADT preferredCultureCode: en-US preferredCurrencyCode: USD nationalIdNumber: null declaredGender: null notificationPreference: 0 required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Preferred Culture Code: description: The provided culture code in the request is an invalid culture identifier. value: errors: - id: null code: nsk:Person:InvalidPreferredCulture message: nsk:Person:InvalidPreferredCulture type: Validation details: null rawMessage: The preferred culture code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Preferred Currency Code: description: The provided currency code in the request is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidPreferredCurrency message: nsk:Person:InvalidPreferredCurrency type: Validation details: null rawMessage: The preferred currency code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid First Name: description: The provided first name in the request starts with a numerical or special character. value: errors: - id: null code: nsk:Validation:InvalidFirstNameCharacters message: "A first name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." type: Validation details: null rawMessage: "A first name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." 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. With Invalid Middle Name: description: The provided middle name in the request starts with a special character. value: errors: - id: null code: nsk:Validation:InvalidMiddleNameCharacters message: "A middle name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>." type: Validation details: null rawMessage: "A middle name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>." 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. With Invalid Last Name: description: The provided last name in the request starts with a numerical or special character. value: errors: - id: null code: nsk:Validation:InvalidLastNameCharacters message: "A last name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." type: Validation details: null rawMessage: "A last name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." 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. Update Status Not Allowed: description: The logged-in user is not allowed to update the person's status. value: errors: - id: null code: nsk:Person:StatusUpdateNotAllowed message: nsk:Person:StatusUpdateNotAllowed type: Validation details: null rawMessage: The logged-in user is not allowed to update their status. 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. Update Type Not Allowed: description: The logged-in user is not allowed to update the person's type. value: errors: - id: null code: nsk:Person:TypeUpdateNotAllowed message: nsk:Person:TypeUpdateNotAllowed type: Validation details: null rawMessage: The logged-in user is not allowed to update their type. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches the specific user's person records basic information. description: 'GraphQL endpoint: usersPersonModify' operationId: nsk_v1_users_userKey_person_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The person patch request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonEditRequest' examples: Person Edit Request: description: Example request for updating person's basic information. value: name: first: John middle: Cee last: Doe title: Mr. suffix: null type: 1 status: 0 details: gender: 1 dateOfBirth: '2006-07-09T05:55:15.8336689+00:00' nationality: US residentCountry: US passengerType: ADT preferredCultureCode: en-US preferredCurrencyCode: USD nationalIdNumber: null declaredGender: null notificationPreference: 0 required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Preferred Culture Code: description: The provided culture code in the request is an invalid culture identifier. value: errors: - id: null code: nsk:Person:InvalidPreferredCulture message: nsk:Person:InvalidPreferredCulture type: Validation details: null rawMessage: The preferred culture code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Preferred Currency Code: description: The provided currency code in the request is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidPreferredCurrency message: nsk:Person:InvalidPreferredCurrency type: Validation details: null rawMessage: The preferred currency code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid First Name: description: The provided first name in the request starts with a numerical or special character. value: errors: - id: null code: nsk:Validation:InvalidFirstNameCharacters message: "A first name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." type: Validation details: null rawMessage: "A first name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." 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. With Invalid Middle Name: description: The provided middle name in the request starts with a special character. value: errors: - id: null code: nsk:Validation:InvalidMiddleNameCharacters message: "A middle name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>." type: Validation details: null rawMessage: "A middle name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>." 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. With Invalid Last Name: description: The provided last name in the request starts with a numerical or special character. value: errors: - id: null code: nsk:Validation:InvalidLastNameCharacters message: "A last name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." type: Validation details: null rawMessage: "A last name may not begin with any of these characters:\ \ :@#$%&_+*-=~^`\u201C\"'\u2018,.:;!?|/\\(){}[]<>0123456789." 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. Update Status Not Allowed: description: The logged-in user is not allowed to update the person's status. value: errors: - id: null code: nsk:Person:StatusUpdateNotAllowed message: nsk:Person:StatusUpdateNotAllowed type: Validation details: null rawMessage: The logged-in user is not allowed to update their status. 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. Update Type Not Allowed: description: The logged-in user is not allowed to update the person's type. value: errors: - id: null code: nsk:Person:TypeUpdateNotAllowed message: nsk:Person:TypeUpdateNotAllowed type: Validation details: null rawMessage: The logged-in user is not allowed to update their type. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/addresses: get: tags: - users summary: Gets all addresses from the specific user's person. description: Gets all addresses from the specific user's person. operationId: nsk_v1_users_userKey_person_addresses_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonAddress' post: tags: - users summary: Creates a new address on the specific user's person. description: 'GraphQL endpoint: usersPersonAddressAdd' operationId: nsk_v1_users_userKey_person_addresses_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new address. content: application/json: schema: $ref: '#/components/schemas/PersonAddressCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/addresses/{personAddressKey}: get: tags: - users summary: Gets a specific address from the specific user's person. description: 'GraphQL endpoint: usersPersonAddress' operationId: nsk_v1_users_userKey_person_addresses_personAddressKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAddressKey in: path required: true description: The unique person address key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonAddress' put: tags: - users summary: Updates a specific address on the specific user's person. description: 'GraphQL endpoint: usersPersonAddressSet' operationId: nsk_v1_users_userKey_person_addresses_personAddressKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAddressKey in: path required: true description: The unique person address key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified address. content: application/json: schema: $ref: '#/components/schemas/PersonAddressEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a specific address on the specific user's person. description: 'GraphQL endpoint: usersPersonAddressModify' operationId: nsk_v1_users_userKey_person_addresses_personAddressKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAddressKey in: path required: true description: The unique person address key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched address. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonAddressEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific address on the specific user's person. description: 'GraphQL endpoint: usersPersonAddressDelete' operationId: nsk_v1_users_userKey_person_addresses_personAddressKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAddressKey in: path required: true description: The unique person address key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/affiliations: get: tags: - users summary: Gets all affiliations from the specific user's person. description: 'GraphQL endpoint: usersPersonAffiliations' operationId: nsk_v1_users_userKey_person_affiliations_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonAffiliation' post: tags: - users summary: Creates a new affiliation for the specific user's person. description: 'GraphQL endpoint: usersPersonAffiliationAdd' operationId: nsk_v1_users_userKey_person_affiliations_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new affiliation. content: application/json: schema: $ref: '#/components/schemas/PersonAffiliationRequest' examples: Person Affiliation Request: description: Example request for creating or updating a person's affiliation. value: name: John Doe required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/affiliations/{personAffiliationKey}: get: tags: - users summary: Gets a specific affiliation from the specific user's person. description: 'GraphQL endpoint: usersPersonAffiliation' operationId: nsk_v1_users_userKey_person_affiliations_personAffiliationKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAffiliationKey in: path required: true description: The unique person affiliation key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonAffiliation' put: tags: - users summary: Updates a specific affiliation for the specific user's person. description: 'GraphQL endpoint: usersPersonAffiliationSet' operationId: nsk_v1_users_userKey_person_affiliations_personAffiliationKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAffiliationKey in: path required: true description: The unique person affiliation key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified affiliation. content: application/json: schema: $ref: '#/components/schemas/PersonAffiliationRequest' examples: Person Affiliation Request: description: Example request for creating or updating a person's affiliation. value: name: John Doe required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Affiliation Key: description: The person affiliation key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonAffiliation' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific affiliation for the specific user's person. description: 'GraphQL endpoint: usersPersonAffiliationDelete' operationId: nsk_v1_users_userKey_person_affiliations_personAffiliationKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAffiliationKey in: path required: true description: The unique person affiliation key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/aliases: get: tags: - users summary: Gets all aliases from the specific user's person. description: Gets all aliases from the specific user's person. operationId: nsk_v1_users_userKey_person_aliases_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonAlias' post: tags: - users summary: Creates a new alias on the specific user's person. description: 'GraphQL endpoint: usersPersonAliasAdd' operationId: nsk_v1_users_userKey_person_aliases_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new alias. content: application/json: schema: $ref: '#/components/schemas/PersonAliasRequest' examples: Person Alias Request: description: Example request for creating or updating a person's alias. value: type: 0 first: John middle: Cee last: Doe title: Mr. suffix: null required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/aliases/{personAliasKey}: get: tags: - users summary: Gets a specific alias from the specific user's person. description: 'GraphQL endpoint: usersPersonAlias' operationId: nsk_v1_users_userKey_person_aliases_personAliasKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAliasKey in: path required: true description: The unique person alias key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonAlias' put: tags: - users summary: Updates a specific alias on the specific user's person. description: 'GraphQL endpoint: usersPersonAliasSet' operationId: nsk_v1_users_userKey_person_aliases_personAliasKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAliasKey in: path required: true description: The unique person alias key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified alias. content: application/json: schema: $ref: '#/components/schemas/PersonAliasRequest' examples: Person Alias Request: description: Example request for creating or updating a person's alias. value: type: 0 first: John middle: Cee last: Doe title: Mr. suffix: null required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Alias Key: description: The person alias key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonAlias' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a specific alias on the specific user's person. description: 'GraphQL endpoint: usersPersonAliasModify' operationId: nsk_v1_users_userKey_person_aliases_personAliasKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAliasKey in: path required: true description: The unique person alias key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched alias. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonAliasRequest' examples: Person Alias Request: description: Example request for creating or updating a person's alias. value: type: 0 first: John middle: Cee last: Doe title: Mr. suffix: null required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Alias Key: description: The person alias key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personAliasKey' with value 'MTW' is invalid. type: Validation details: personAliasKey: MTW rawMessage: The identifier 'personAliasKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific alias on the specific user's person. description: 'GraphQL endpoint: usersPersonAliasDelete' operationId: nsk_v1_users_userKey_person_aliases_personAliasKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personAliasKey in: path required: true description: The unique person alias key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/comments: get: tags: - users summary: Gets all comments from the specific user's person. description: 'GraphQL endpoint: usersPersonComments' operationId: nsk_v1_users_userKey_person_comments_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonComment' post: tags: - users summary: Creates a new comment on the specific user's person. description: 'GraphQL endpoint: usersPersonCommentAdd' operationId: nsk_v1_users_userKey_person_comments_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new comment. content: application/json: schema: $ref: '#/components/schemas/PersonCommentRequest' examples: Person Comment Request: description: Example request for creating or updating a person's comment. value: text: Comment type: 0 required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/comments/{personCommentKey}: get: tags: - users summary: Gets a specific comment from the specific user's person. description: 'GraphQL endpoint: usersPersonComment' operationId: nsk_v1_users_userKey_person_comments_personCommentKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personCommentKey in: path required: true description: The unique person comment key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonComment' put: tags: - users summary: Updates a specific comment on the specific user's person. description: 'GraphQL endpoint: usersPersonCommentSet' operationId: nsk_v1_users_userKey_person_comments_personCommentKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personCommentKey in: path required: true description: The unique person comment key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified comment. content: application/json: schema: $ref: '#/components/schemas/PersonCommentRequest' examples: Person Comment Request: description: Example request for creating or updating a person's comment. value: text: Comment type: 0 required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Comment Key: description: The person comment key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonComment' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a specific comment on the specific user's person. description: 'GraphQL endpoint: usersPersonCommentModify' operationId: nsk_v1_users_userKey_person_comments_personCommentKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personCommentKey in: path required: true description: The unique person comment key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched comment. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonCommentRequest' examples: Person Comment Request: description: Example request for creating or updating a person's comment. value: text: Comment type: 0 required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Comment Key: description: The person comment key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonComment' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific comment on the specific user's person. description: 'GraphQL endpoint: usersPersonCommentDelete' operationId: nsk_v1_users_userKey_person_comments_personCommentKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personCommentKey in: path required: true description: The unique person comment key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/emails: get: tags: - users summary: Gets all email addresses from the specific user's person. description: Gets all email addresses from the specific user's person. operationId: nsk_v1_users_userKey_person_emails_get parameters: - name: userKey in: path required: true description: The user key of the user whose email addresses to retrieve. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonEmail' post: tags: - users summary: Creates a new email address on the specific user's person. description: 'The "type" property for the request is a single character. See the "/resources/EmailTypes" endpoint for valid email type codes. GraphQL endpoint: usersPersonEmailAdd' operationId: nsk_v1_users_userKey_person_emails_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new email address. content: application/json: schema: $ref: '#/components/schemas/EmailCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/emails/{personEmailAddressKey}: get: tags: - users summary: Gets a specific email address from the specific user's person. description: 'GraphQL endpoint: usersPersonEmail' operationId: nsk_v1_users_userKey_person_emails_personEmailAddressKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personEmailAddressKey in: path required: true description: The unique person email address key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonEmail' put: tags: - users summary: Updates a specific email address on the specific user's person. description: 'GraphQL endpoint: usersPersonEmailSet' operationId: nsk_v1_users_userKey_person_emails_personEmailAddressKey_put parameters: - name: userKey in: path required: true description: The specific user key. schema: type: string x-position: 1 - name: personEmailAddressKey in: path required: true description: The unique person email address key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified email address. content: application/json: schema: $ref: '#/components/schemas/EmailEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a specific email address on the specific user's person. description: 'GraphQL endpoint: usersPersonEmailModify' operationId: nsk_v1_users_userKey_person_emails_personEmailAddressKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personEmailAddressKey in: path required: true description: The unique person email address key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched email address. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfEmailEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific email address on the specific user's person. description: 'GraphQL endpoint: usersPersonEmailDelete' operationId: nsk_v1_users_userKey_person_emails_personEmailAddressKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personEmailAddressKey in: path required: true description: The unique person email address key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/information: get: tags: - users summary: Gets all information for a specific user's person. description: 'GraphQL endpoint: usersPersonInformations' operationId: nsk_v1_users_userKey_person_information_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonInformation' examples: Retrieve Person Information: description: Successful retrieval of person information value: personInformationKey: NTcxMzkhQQ- size: 246 personInformationTypeCode: A data:
John Doe Harrison Street Los Angeles US post: tags: - users summary: Creates new information for a specific user's person. description: 'GraphQL endpoint: usersPersonInformationAdd' operationId: nsk_v1_users_userKey_person_information_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new information. content: application/json: schema: $ref: '#/components/schemas/PersonInformationCreateRequest' examples: Create Person Information: description: Example request for creating person information. For a list of valid person information type code, kindly refer to the GET /api/nsk/v1/resources/PersonInformationTypes endpoint. value: personInformationTypeCode: A data:
John Doe Harrison Street Los Angeles US required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid nor does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. /api/nsk/v1/users/{userKey}/person/information/{personInformationKey}: get: tags: - users summary: Gets specific information for a specific user's person. description: 'GraphQL endpoint: usersPersonInformation' operationId: nsk_v1_users_userKey_person_information_personInformationKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personInformationKey in: path required: true description: The unique person information key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonInformation' examples: Retrieve Person Information: description: Successful retrieval of person information value: personInformationKey: NTcxMzkhQQ- size: 246 personInformationTypeCode: A data:
John Doe Harrison Street Los Angeles US put: tags: - users summary: Updates specific information for a specific user's person. description: 'GraphQL endpoint: usersPersonInformationSet' operationId: nsk_v1_users_userKey_person_information_personInformationKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personInformationKey in: path required: true description: The unique person information key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified information. content: application/json: schema: $ref: '#/components/schemas/PersonInformationEditRequest' examples: Modify Person Information: description: Example request for modifying person information value: data:
John Doe Harrison Street Los Angeles US required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid nor does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid or Null Person Information Key: description: The person information key is empty, not valid or does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches specific information for a specific user's person. description: 'GraphQL endpoint: usersPersonInformationModify' operationId: nsk_v1_users_userKey_person_information_personInformationKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personInformationKey in: path required: true description: The unique person information key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched information. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonInformationEditRequest' examples: Modify Person Information: description: Example request for modifying person information value: data:
John Doe Harrison Street Los Angeles US required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid nor does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid or Null Person Information Key: description: The person information key is empty, not valid or does not exist. value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonInformation' has failed. Please verify this object exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: 99cd1b2b-ccc3-4733-7fa4-2bf49b1d98c0 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes specific information for a specific user's person. description: 'GraphQL endpoint: usersPersonInformationDelete' operationId: nsk_v1_users_userKey_person_information_personInformationKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personInformationKey in: path required: true description: The unique person information key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/phoneNumbers: get: tags: - users summary: Gets all phone numbers from the specific user's person. description: Gets all phone numbers from the specific user's person. operationId: nsk_v1_users_userKey_person_phoneNumbers_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonPhoneNumber' post: tags: - users summary: Creates a new phone number on the specific user's person. description: 'GraphQL endpoint: usersPersonPhoneNumberAdd' operationId: nsk_v1_users_userKey_person_phoneNumbers_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new phone number. content: application/json: schema: $ref: '#/components/schemas/PersonPhoneNumberRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/phoneNumbers/{personPhoneNumberKey}: get: tags: - users summary: Gets a specific phone number from the specific user's person. description: 'GraphQL endpoint: usersPersonPhoneNumber' operationId: nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personPhoneNumberKey in: path required: true description: The unique person phone number key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonPhoneNumber' put: tags: - users summary: Updates a specific phone number on the specific user's person. description: 'GraphQL endpoint: usersPersonPhoneNumberSet' operationId: nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personPhoneNumberKey in: path required: true description: The unique person phone number key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified phone number. content: application/json: schema: $ref: '#/components/schemas/PersonPhoneNumberRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a specific phone number on the specific user's person. description: 'GraphQL endpoint: usersPersonPhoneNumberModify' operationId: nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personPhoneNumberKey in: path required: true description: The unique person phone number key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched phone number. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonPhoneNumberRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific phone number on the specific user's person. description: 'GraphQL endpoint: usersPersonPhoneNumberDelete' operationId: nsk_v1_users_userKey_person_phoneNumbers_personPhoneNumberKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personPhoneNumberKey in: path required: true description: The unique person phone number key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/preferences: get: tags: - users summary: Gets all preferences for a specific user's person. description: Gets all preferences for a specific user's person. operationId: nsk_v1_users_userKey_person_preferences_get parameters: - name: userKey in: path required: true description: The unique person key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonPreference' post: tags: - users summary: Creates a new preference for a specific user's person. description: 'GraphQL endpoint: usersPersonPreferenceAdd' operationId: nsk_v1_users_userKey_person_preferences_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new preference. content: application/json: schema: $ref: '#/components/schemas/PersonPreferenceCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/preferences/{personPreferenceKey}: get: tags: - users summary: Gets a specific preference for a specific user's person. description: 'GraphQL endpoint: usersPersonPreference' operationId: nsk_v1_users_userKey_person_preferences_personPreferenceKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personPreferenceKey in: path required: true description: The unique person preference key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonPreference' put: tags: - users summary: Updates a specific preference for a specific user's person. description: 'GraphQL endpoint: usersPersonPreferenceSet' operationId: nsk_v1_users_userKey_person_preferences_personPreferenceKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personPreferenceKey in: path required: true description: The unique person preference key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified preference. content: application/json: schema: $ref: '#/components/schemas/PersonPreferenceEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a specific preference for a specific user's person. description: 'GraphQL endpoint: usersPersonPreferenceModify' operationId: nsk_v1_users_userKey_person_preferences_personPreferenceKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personPreferenceKey in: path required: true description: The unique person preference key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched preference. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonPreferenceEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific preference for a specific user's person. description: 'GraphQL endpoint: usersPersonPreferenceDelete' operationId: nsk_v1_users_userKey_person_preferences_personPreferenceKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personPreferenceKey in: path required: true description: The unique person preference key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/programs: get: tags: - users summary: Gets all programs from the specific user's person. description: 'GraphQL endpoint: usersPersonPrograms' operationId: nsk_v1_users_userKey_person_programs_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonCustomerProgram' post: tags: - users summary: Creates a new program on the specific user's person. description: 'GraphQL endpoint: usersPersonProgramAdd' operationId: nsk_v1_users_userKey_person_programs_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new program. content: application/json: schema: $ref: '#/components/schemas/PersonCustomerProgramCreateRequest' examples: Person Customer Program Create Request: description: Example request for creating a person's customer program. value: programCode: LOY programNumber: '12345' effectiveDate: '2026-07-10T00:00:00+00:00' expirationDate: '2027-07-09T00:00:00+00:00' default: true programLevelCode: A required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. With Invalid Program Code: description: The program code is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidProgramCode message: nsk:Person:InvalidProgramCode type: Validation details: null rawMessage: The program code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Program Level Code: description: The program level code is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidProgramLevelCode message: nsk:Person:InvalidProgramLevelCode type: Validation details: null rawMessage: The program level code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/programs/{personProgramKey}: get: tags: - users summary: Gets a specific program from the specific user's person. description: 'GraphQL endpoint: usersPersonProgram' operationId: nsk_v1_users_userKey_person_programs_personProgramKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personProgramKey in: path required: true description: The unique person program key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonCustomerProgram' put: tags: - users summary: Updates a specific program on the specific user's person. description: 'GraphQL endpoint: usersPersonProgramSet' operationId: nsk_v1_users_userKey_person_programs_personProgramKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personProgramKey in: path required: true description: The unique person program key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified program. content: application/json: schema: $ref: '#/components/schemas/PersonCustomerProgramEditRequest' examples: Person Customer Program Edit Request: description: Example request for updating a person's customer program. value: programNumber: '12345' effectiveDate: '2026-07-10T00:00:00+00:00' expirationDate: '2027-07-09T00:00:00+00:00' default: true programLevelCode: A required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Program Key: description: The person program key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'PersonCustomerProgram' has failed. Please verify this object exists. 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. With Invalid Program Level Code: description: The program level code is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidProgramLevelCode message: nsk:Person:InvalidProgramLevelCode type: Validation details: null rawMessage: The program level code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a specific program on the specific user's person. description: 'GraphQL endpoint: usersPersonProgramModify' operationId: nsk_v1_users_userKey_person_programs_personProgramKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personProgramKey in: path required: true description: The unique person program key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched program. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonCustomerProgramEditRequest' examples: Person Customer Program Edit Request: description: Example request for updating a person's customer program. value: programNumber: '12345' effectiveDate: '2026-07-10T00:00:00+00:00' expirationDate: '2027-07-09T00:00:00+00:00' default: true programLevelCode: A required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Program Key: description: The person program key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personProgramKey' with value 'MTW' is invalid. type: Validation details: personProgramKey: MTW rawMessage: The identifier 'personProgramKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Program Level Code: description: The program level code is not valid or does not exist. value: errors: - id: null code: nsk:Person:InvalidProgramLevelCode message: nsk:Person:InvalidProgramLevelCode type: Validation details: null rawMessage: The program level code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific program on the specific user's person. description: 'GraphQL endpoint: usersPersonProgramDelete' operationId: nsk_v1_users_userKey_person_programs_personProgramKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personProgramKey in: path required: true description: The unique person address key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/storedPayments: get: tags: - users summary: Gets all stored payments from the specific user's person. description: Gets all stored payments from the specific user's person. operationId: nsk_v1_users_userKey_person_storedPayments_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonStoredPayment' post: tags: - users summary: Creates a new stored payment on the specific user's person. description: 'GraphQL endpoint: usersPersonStoredPaymentAdd' operationId: nsk_v1_users_userKey_person_storedPayments_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new stored payment. content: application/json: schema: $ref: '#/components/schemas/PersonStoredPaymentRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/storedPayments/{personStoredPaymentKey}: get: tags: - users summary: Gets a specific stored payment from the specific user's person. description: 'GraphQL endpoint: usersPersonStoredPayment' operationId: nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personStoredPaymentKey in: path required: true description: The unique person stored payment key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonStoredPayment' put: tags: - users summary: Updates a specific stored payment on the specific user's person. description: 'To update the account number please DELETE and POST a new stored payment. GraphQL endpoint: usersPersonStoredPaymentSet' operationId: nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personStoredPaymentKey in: path required: true description: The unique person stored payment key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified stored payment. content: application/json: schema: $ref: '#/components/schemas/PersonStoredPaymentUpdateRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a specific stored payment on the specific user's person. description: 'To update the account number please DELETE and POST a new stored payment. GraphQL endpoint: usersPersonStoredPaymentModify' operationId: nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personStoredPaymentKey in: path required: true description: The unique person stored payment key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched stored payment. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfPersonStoredPaymentUpdateRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific stored payment on the specific user's person. description: 'GraphQL endpoint: usersPersonStoredPaymentDelete' operationId: nsk_v1_users_userKey_person_storedPayments_personStoredPaymentKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personStoredPaymentKey in: path required: true description: The unique person stored payment key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/travelDocuments: get: tags: - users summary: Gets all travel documents from the specific user's person. description: Gets all travel documents from the specific user's person. operationId: nsk_v1_users_userKey_person_travelDocuments_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonTravelDocument' post: tags: - users summary: 'Creates a new travel document on the specific user''s person. Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object. This is by design due to New Skies validation on the Gender property, and on the Travel Document Date of Birth being trusted over the person record Date of Birth.' description: 'GraphQL endpoint: usersPersonTravelDocumentAddv2' operationId: nsk_v1_users_userKey_person_travelDocuments_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new travel document. content: application/json: schema: $ref: '#/components/schemas/PersonTravelDocumentRequest' examples: Person Travel Document Request: description: Example request for creating a person's travel document. value: default: true documentTypeCode: P birthCountry: US issuedByCode: US name: first: John middle: Cee last: Doe title: Mr. suffix: null nationality: US expirationDate: '2034-07-09T05:55:15.9015943+00:00' number: P12345678 issuedDate: '2024-07-09T05:55:15.9015969+00:00' gender: 1 dateOfBirth: '2001-07-09T05:55:15.9015974+00:00' declaredGender: Male placeOfBirth: US placeOfIssue: US required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Travel Document Type: description: The travel document type provided is not valid or not configured in the system. value: errors: - id: null code: nsk:Person:InvalidTravelDocumentType message: nsk:Person:InvalidTravelDocumentType type: Validation details: null rawMessage: The document type code 'ZZZ' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Duplicate Travel Document: description: The travel document already exists. value: errors: - id: null code: nsk:Exceptions:DuplicateCreateFailed message: nsk:Exceptions:DuplicateCreateFailed type: Validation details: null rawMessage: Attempted create of object 'PersonTravelDocument' has failed. The object already exists. 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. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/travelDocuments/{personTravelDocumentKey}: get: tags: - users summary: Gets a specific travel document from the specific user's person. description: 'GraphQL endpoint: usersPersonTravelDocumentv2' operationId: nsk_v1_users_userKey_person_travelDocuments_personTravelDocumentKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personTravelDocumentKey in: path required: true description: The unique person travel document key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonTravelDocument' delete: tags: - users summary: Deletes a specific travel document on the specific user's person. description: 'GraphQL endpoint: usersPersonTravelDocumentDeletev2' operationId: nsk_v1_users_userKey_person_travelDocuments_personTravelDocumentKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personTravelDocumentKey in: path required: true description: The unique person travel document key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/users/{userKey}/person/travelDocuments/{personTravelDocumentKey}: put: tags: - users summary: 'Updates a specific travel document on the specific user''s person. Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object. This is by design due to New Skies validation on the Gender property, and on the Travel Document Date of Birth being trusted over the person record Date of Birth.' description: 'GraphQL endpoint: usersPersonTravelDocumentSetv2' operationId: nsk_v2_users_userKey_person_travelDocuments_personTravelDocumentKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personTravelDocumentKey in: path required: true description: The unique person travel document key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified travel document. content: application/json: schema: $ref: '#/components/schemas/TravelDocumentEditRequestv2' examples: Person Travel Document Edit Request: description: Example request for updating a person's travel document. value: birthCountry: US name: first: John middle: Cee last: Doe title: Mr. suffix: null nationality: US expirationDate: '2034-07-09T05:55:15.933836+00:00' number: P12345678 issuedDate: '2024-07-09T05:55:15.9338714+00:00' default: true gender: 1 dateOfBirth: '2001-07-09T05:55:15.933929+00:00' declaredGender: Male placeOfBirth: US placeOfIssue: US required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Travel Document Key: description: The travel document key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid. type: Validation details: personTravelDocumentKey: MTW rawMessage: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: 'Patches a specific travel document on the specific user''s person. Note: Gender and Date of Birth on the Travel Document will overwrite the values on the related person object. This is by design due to New Skies validation on the Gender property, and on the Travel Document Date of Birth being trusted over the person record Date of Birth.' description: 'GraphQL endpoint: usersPersonTravelDocumentModifyv2' operationId: nsk_v2_users_userKey_person_travelDocuments_personTravelDocumentKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: personTravelDocumentKey in: path required: true description: The unique person travel document key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched travel document. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelDocumentEditRequestv2' examples: Person Travel Document Edit Request: description: Example request for updating a person's travel document. value: birthCountry: US name: first: John middle: Cee last: Doe title: Mr. suffix: null nationality: US expirationDate: '2034-07-09T05:55:15.9376019+00:00' number: P12345678 issuedDate: '2024-07-09T05:55:15.937603+00:00' default: true gender: 1 dateOfBirth: '2001-07-09T05:55:15.9376033+00:00' declaredGender: Male placeOfBirth: US placeOfIssue: US required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: With Invalid User Key: description: The user key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'userKey' with value 'MTW' is invalid. type: Validation details: userKey: MTW rawMessage: The identifier 'userKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Invalid Person Travel Document Key: description: The travel document key is not valid or does not exist. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid. type: Validation details: personTravelDocumentKey: MTW rawMessage: The identifier 'personTravelDocumentKey' with value 'MTW' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. With Null Request: description: Example response when attempting to call the endpoint with a null request value: errors: - id: null code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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. '401': description: Authorization Not Allowed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/travelNotifications: get: tags: - users summary: Gets person travel notifications for a user's person. description: 'GraphQL endpoint: usersPersonTravelNotifications' operationId: nsk_v1_users_userKey_person_travelNotifications_get parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonTravelNotification' post: tags: - users summary: Creates a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonTravelNotificationAdd' operationId: nsk_v1_users_userKey_person_travelNotifications_post parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 requestBody: x-name: request description: The travel notification create request. content: application/json: schema: $ref: '#/components/schemas/TravelNotificationCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}: get: tags: - users summary: Gets a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonTravelNotification' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_get parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The person travel notification key. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPersonTravelNotification' put: tags: - users summary: Updates a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonTravelNotificationSet' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_put parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The travel notification edit request. content: application/json: schema: $ref: '#/components/schemas/TravelNotificationEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonTravelNotificationModify' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_patch parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The delta mapper travel notification edit request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfTravelNotificationEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonTravelNotificationDelete' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_delete parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/events: get: tags: - users summary: Gets notification events for a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonNotificationEvents' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_get parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - users summary: Creates a notification event for a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonNotificationEventAdd' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_post parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The notification event create request. content: application/json: schema: $ref: '#/components/schemas/NotificationEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/events/{eventType}: get: tags: - users summary: Gets a notification event for a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonNotificationEvent' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_eventType_get parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: eventType in: path required: true description: "The event type. \nEnumeration values: 0 = DepartureDelay, 1\ \ = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" schema: $ref: '#/components/schemas/NotificationEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNotificationEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a notification event from a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonNotificationEventDelete' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_events_eventType_delete parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: eventType in: path required: true description: "The notification event type. \nEnumeration values: 0 = DepartureDelay,\ \ 1 = ArrivalDelay, 2 = ScheduleChange, 3 = CheckIn, 4 = GateInformation" schema: $ref: '#/components/schemas/NotificationEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/timedEvents: get: tags: - users summary: Gets notification timed events for a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonNotificationTimedEvents' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_get parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationTimedEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - users summary: Creates a notification timed event for a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonNotificationTimedEventAdd' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_post parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 requestBody: x-name: request description: The notification timed even create request. content: application/json: schema: $ref: '#/components/schemas/NotificationTimedEventCreateRequest' required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/person/travelNotifications/{travelNotificationKey}/timedEvents/{timedEventType}: get: tags: - users summary: Gets a notification timed event for a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonNotificationTimedEvent' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_timedEventType_get parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The timed event type. \nEnumeration values: 0 = Departure, 1\ \ = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNotificationTimedEvent' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - users summary: Updates a notification timed event for a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonNotificationTimedEventSet' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_timedEventType_put parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The notification timed event type. \nEnumeration values: 0 =\ \ Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 requestBody: x-name: request description: The updated notification timed event request. content: application/json: schema: $ref: '#/components/schemas/NotificationTimedEventEditRequest' required: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a notification timed event from a person travel notification for a user's person. description: 'GraphQL endpoint: usersPersonNotificationTimedEventDelete' operationId: nsk_v1_users_userKey_person_travelNotifications_travelNotificationKey_timedEvents_timedEventType_delete parameters: - name: userKey in: path required: true description: The user key. schema: type: string x-position: 1 - name: travelNotificationKey in: path required: true description: The travel notification key. schema: type: string x-position: 2 - name: timedEventType in: path required: true description: "The notification timed event type. \nEnumeration values: 0 =\ \ Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/preferences/skySpeedSettings: get: tags: - users summary: Retrieves the default SkySpeed settings user preferences of the specified user. description: 'GraphQL endpoint: usersPreferencesSkySpeedSettings' operationId: nsk_v1_users_userKey_preferences_skySpeedSettings_get parameters: - name: userKey in: path required: true description: The unique identifier of the user. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSkySpeedSettingsUserPreferences' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true put: tags: - users summary: Updates the default SkySpeed settings user preferences of the specified user. description: 'If the SkySpeed settings of the current user is disabled and an update is made, the settings will automatically be enabled and updated. If given, each string property is validated if it exists and is active. The collection currency setting can only be CollectionCurrencySetting.None if the collection currency code is null or empty. A bad request will be returned if the collection currency code and collection currency setting are: - Collection Currency Code is not null or empty and the Collection Currency Setting is set to CollectionCurrency.None. - Collection Currency Code is null or empty and the Collection Currency Setting is set to CollectionCurrency.Both (Any value except for CollectionCurrencySetting.None). GraphQL endpoint: usersPreferencesSkySpeedSettingsSet' operationId: nsk_v1_users_userKey_preferences_skySpeedSettings_put parameters: - name: userKey in: path required: true description: The unique identifier of the user. schema: type: string x-position: 1 requestBody: x-name: request description: The SkySpeed settings user preferences. content: application/json: schema: $ref: '#/components/schemas/SkySpeedSettingsUserPreferences' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/users/{userKey}/preferences/skySpeedSettings: get: tags: - users summary: Retrieves the default SkySpeed settings user preferences of the specified user. description: 'GraphQL endpoint: usersPreferencesSkySpeedSettingsv2' operationId: nsk_v2_users_userKey_preferences_skySpeedSettings_get parameters: - name: userKey in: path required: true description: The unique identifier of the user. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSkySpeedSettingsUserPreferences' examples: Sky Speed preferences found.: description: Example response when Sky Speed preferences are successfully retrieved. value: data: currencyCode: USD cultureCode: en-US countryCode: US nationality: US collectionCurrencyCode: EUR collectionCurrencySetting: 2 flightResultFareType: 1 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Sky Speed preferences not found: description: Example response when a GET returns a 404 not found HTTP status code. value: data: null put: tags: - users summary: Updates the default SkySpeed settings user preferences of the specified user. description: 'If the SkySpeed settings of the current user is disabled and an update is made, the settings will automatically be enabled and updated. If given, each string property is validated if it exists and is active. The collection currency setting can only be CollectionCurrencySetting.None if the collection currency code is null or empty. A bad request will be returned if the collection currency code and collection currency setting are: - Collection Currency Code is not null or empty and the Collection Currency Setting is set to CollectionCurrency.None. - Collection Currency Code is null or empty and the Collection Currency Setting is set to CollectionCurrency.Both (Any value except for CollectionCurrencySetting.None). GraphQL endpoint: usersPreferencesSkySpeedSettingsSetv2' operationId: nsk_v2_users_userKey_preferences_skySpeedSettings_put parameters: - name: userKey in: path required: true description: The unique identifier of the user. schema: type: string x-position: 1 requestBody: x-name: request description: The SkySpeed settings user preferences. content: application/json: schema: $ref: '#/components/schemas/SkySpeedSettingsUserPreferences' examples: Update Sky Speed settings: description: Example request for updating Sky Speed user settings preferences. value: currencyCode: USD cultureCode: en-US countryCode: US nationality: US collectionCurrencyCode: EUR collectionCurrencySetting: 3 flightResultFareType: 0 required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Sky Speed preferences updated: description: Example response when update is successful. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: String length attribute errors: description: Example response when a request property string length is too long. value: errors: - id: null code: SkySpeedSettingsUserPreferences.CurrencyCode:StringLengthAttribute message: SkySpeedSettingsUserPreferences.CurrencyCode:StringLengthAttribute type: Validation details: member: CurrencyCode model: SkySpeedSettingsUserPreferences validation: StringLengthAttribute rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. - id: null code: SkySpeedSettingsUserPreferences.CultureCode:StringLengthAttribute message: SkySpeedSettingsUserPreferences.CultureCode:StringLengthAttribute type: Validation details: member: CultureCode model: SkySpeedSettingsUserPreferences validation: StringLengthAttribute rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. - id: null code: SkySpeedSettingsUserPreferences.CountryCode:StringLengthAttribute message: SkySpeedSettingsUserPreferences.CountryCode:StringLengthAttribute type: Validation details: member: CountryCode model: SkySpeedSettingsUserPreferences validation: StringLengthAttribute rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. - id: null code: SkySpeedSettingsUserPreferences.Nationality:StringLengthAttribute message: SkySpeedSettingsUserPreferences.Nationality:StringLengthAttribute type: Validation details: member: Nationality model: SkySpeedSettingsUserPreferences validation: StringLengthAttribute rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. - id: null code: SkySpeedSettingsUserPreferences.CollectionCurrencyCode:StringLengthAttribute message: SkySpeedSettingsUserPreferences.CollectionCurrencyCode:StringLengthAttribute type: Validation details: member: CollectionCurrencyCode model: SkySpeedSettingsUserPreferences validation: StringLengthAttribute rawMessage: The field SkySpeedSettingsUserPreferences must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid request codes: description: Example response when certain codes have invalid data. value: errors: - id: null code: nsk:UserPreferences:SkySpeedSettings:InvalidCurrencyCode message: The currency code `AAA` does not exist or is inactive. type: null details: currencyCode: AAA 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. - id: null code: nsk:UserPreferences:SkySpeedSettings:InvalidCultureCode message: The culture code `AS-ASD` does not exist or is inactive. type: null details: cultureCode: AS-ASD 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. - id: null code: nsk:UserPreferences:SkySpeedSettings:InvalidCountryCode message: The country code `QQ` does not exist or is inactive. type: null details: countryCode: QQ 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. - id: null code: nsk:UserPreferences:SkySpeedSettings:InvalidNationality message: The nationality `QQ` does not exist or is inactive. type: null details: nationality: QQ 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. - id: null code: nsk:UserPreferences:SkySpeedSettings:InvalidCollectionCurrencyCode message: The collection currency code `AAA` does not exist or is inactive. type: null details: collectionCurrencyCode: AAA 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 Enum out of range error code: description: Example response when an enumeration request value is out of the expected enumeration values. value: errors: - id: null code: core:Validation:EnumOutOfRange message: core:Validation:EnumOutOfRange type: Validation details: name: CollectionCurrencySetting value: '6' rawMessage: The enum 'CollectionCurrencySetting' contains an invalid value of '6'. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid collected currency code and setting combination.: description: Example response when an invalid combination of collected currency code and setting is requested. value: errors: - id: null code: nsk:UserPreferences:SkySpeedSettings:InvalidCollectionCurrencyCodeAndSetting message: nsk:UserPreferences:SkySpeedSettings:InvalidCollectionCurrencyCodeAndSetting type: null details: collectionCurrencyCode: USD collectionCurrencyCodeSetting: None rawMessage: The collection currency code `USD` and setting `None` are invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Null request.: description: Example response when null request is received by the endpoint. value: errors: - id: null code: nsk:UserPreferences:SkySpeedSettings:SkySpeedSettingsUserPreferencesRequired message: nsk:UserPreferences:SkySpeedSettings:SkySpeedSettingsUserPreferencesRequired type: Error details: null rawMessage: The SkySpeedSettingsUserPreferences is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/users/{userKey}/roles: get: tags: - users summary: Gets all roles for a specific user. description: Gets all roles for a specific user. operationId: nsk_v1_users_userKey_roles_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfUserRole' post: tags: - users summary: Creates a new role for a specific user. description: 'GraphQL endpoint: usersRoleAdd' operationId: nsk_v1_users_userKey_roles_post parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 requestBody: x-name: request description: The new role. content: application/json: schema: $ref: '#/components/schemas/UserRoleCreateRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/{userKey}/roles/{userRoleKey}: get: tags: - users summary: Gets a specific role for a specific user. description: 'GraphQL endpoint: usersRole' operationId: nsk_v1_users_userKey_roles_userRoleKey_get parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: userRoleKey in: path required: true description: The unique user role key schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfUserRole' put: tags: - users summary: Updates a specific role for a specific user. description: 'GraphQL endpoint: usersRoleSet' operationId: nsk_v1_users_userKey_roles_userRoleKey_put parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: userRoleKey in: path required: true description: The unique user role key. schema: type: string x-position: 2 requestBody: x-name: request description: The modified role. content: application/json: schema: $ref: '#/components/schemas/UserRoleEditRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - users summary: Patches a specific role for a specific user. description: 'GraphQL endpoint: usersRoleModify' operationId: nsk_v1_users_userKey_roles_userRoleKey_patch parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: userRoleKey in: path required: true description: The unique user role key. schema: type: string x-position: 2 requestBody: x-name: request description: The patched role. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfUserRolePatchRequest' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - users summary: Deletes a specific role for a specific user. description: 'GraphQL endpoint: usersRoleDelete' operationId: nsk_v1_users_userKey_roles_userRoleKey_delete parameters: - name: userKey in: path required: true description: The unique user key. schema: type: string x-position: 1 - name: userRoleKey in: path required: true description: The unique user role key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/users/byPerson/{personKey}: get: tags: - users summary: Retrieves the a specific user by the person key. description: 'GraphQL endpoint: usersByPerson' operationId: nsk_v1_users_byPerson_personKey_get parameters: - name: personKey in: path required: true description: The person key of the user to retrieve. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfUser' /api/nsk/v1/utilities/stationLocalTime/{stationCode}: get: tags: - utilities summary: Retrieves the station local time. description: Retrieves the station local time. operationId: nsk_v1_utilities_stationLocalTime_stationCode_get parameters: - name: stationCode in: path required: true description: The station code to get the local time for. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDateTime' /api/dcs/v1/verifiedTravelDocuments: put: tags: - verifiedTravelDocuments summary: Updates a list of verified travel documents for a passenger and associated infant. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` The following items are required to use this endpoint. Agent permissions. Government Security Drivers need to be enabled under government security configurations. Government Security Drivers need to be configured to approve the given document type. The given document must be a document type approved by customs. The target passenger must be either checked in or boarded on the target segment. Due to the nature of this endpoint there is no data returned. To confirm successful update you can find an entry in the booking history using `/api/nsk/v1/bookings/{bookingKey}/history` or view passenger segment information by pulling the booking using `/api/nsk/v1/bookings/{recordLocator}` If you would like to remove all verified travel documents from a passenger please use DELETE `/api/dcs/v1/verifiedTravelDocuments/{recordLocator}/segments/{segmentKey}/passengers/{passengerKey}` GraphQL endpoint: verifiedTravelDocumentsSet' operationId: dcs_v1_verifiedTravelDocuments_put requestBody: x-name: request description: The request for updating verified travel documents on a bookings. content: application/json: schema: $ref: '#/components/schemas/UpdateVerifiedTravelDocumentsRequest' examples: Example updated verified travel documents request: description: An example of an update verified travel documents request. value: recordLocator: ABC123 segmentKey: TlZ_NTYwOH4gfn5TTEN_MDcvMjEvMjAyNCAxNzowMH5CT1N_MDcvMjEvMjAyNCAyMzo1OX5_ passengerKey: MCFBRFQ- verifiedTravelDocuments: - documentTypeCode: P issuedByCode: US isInfant: false required: true x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Segment Key Error: description: Example error when segment key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: segmentKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'SegmentKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Lift Status Error: description: Example error when lift status is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidLiftStatus message: Updating verified travel documents requires the passenger to have a lift status of checked in or boarded. Lift status for passenger JoKwkYODu4gNYRwNQo is currently Default. type: Validation details: null 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 Invalid Document Type Error: description: Example error when document type is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidDocumentType message: The document type code 'INVALID' is invalid or inactive. type: Validation details: null 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 Invalid Issued by Code Error: description: Example error when document issued by code is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidIssuedByCode message: The issued by code 'INVALID' is invalid or inactive. type: Validation details: null 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 '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/dcs/v1/verifiedTravelDocuments/{recordLocator}/segments/{segmentKey}/passengers/{passengerKey}: post: tags: - verifiedTravelDocuments summary: Adds a new verified travel document to a passenger or the associated infant. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` The following items are required to use this endpoint. Agent permissions. Government Security Drivers need to be enabled under government security configurations. Government Security Drivers need to be configured to approve the given document type. The given document must be a document type approved by customs. The target passenger must be either checked in or boarded on the target segment. Due to the nature of this endpoint there is no data returned. To confirm successful update you can find an entry in the booking history using GET `/api/nsk/v1/bookings/{bookingKey}/history` or view passenger segment information by pulling the booking using GET `/api/nsk/v1/bookings/{recordLocator}` GraphQL endpoint: verifiedTravelDocumentsAdd' operationId: dcs_v1_verifiedTravelDocuments_recordLocator_segments_segmentKey_passengers_passengerKey_post parameters: - name: recordLocator in: path required: true description: The record locator of the target booking. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The target segment key. schema: type: string x-position: 2 - name: passengerKey in: path required: true description: The target passenger key. schema: type: string x-position: 3 requestBody: x-name: request description: The request for updating verified travel documents on a bookings. content: application/json: schema: $ref: '#/components/schemas/VerifiedTravelDocument' examples: Example verified travel document: description: An example of a basic verified travel document. value: documentTypeCode: P issuedByCode: US isInfant: false required: true x-position: 4 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Segment Key Error: description: Example error when segment key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: segmentKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'SegmentKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Lift Status Error: description: Example error when lift status is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidLiftStatus message: Updating verified travel documents requires the passenger to have a lift status of checked in or boarded. Lift status for passenger JoKwkYODu4gNYRwNQo is currently Default. type: Validation details: null 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 Invalid Document Type Error: description: Example error when document type is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidDocumentType message: The document type code 'INVALID' is invalid or inactive. type: Validation details: null 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 Invalid Issued by Code Error: description: Example error when document issued by code is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidIssuedByCode message: The issued by code 'INVALID' is invalid or inactive. type: Validation details: null 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 delete: tags: - verifiedTravelDocuments summary: Deletes the verified travel documents for a passenger and associated infant. description: 'Requires agent permissions. This will delete all verified documents associated with the passenger which includes infant travel documents. If you would like to update the list without removing all of them please use PUT `/api/dcs/v1/verifiedTravelDocuments` IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems. GraphQL endpoint: verifiedTravelDocumentsDelete' operationId: dcs_v1_verifiedTravelDocuments_recordLocator_segments_segmentKey_passengers_passengerKey_delete parameters: - name: recordLocator in: path required: true description: The record locator of the target booking. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The target segment key. schema: type: string x-position: 2 - name: passengerKey in: path required: true description: The target passenger key. schema: type: string x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '409': description: Concurrent changes were being made in the same session. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Segment Key Error: description: Example error when segment key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: segmentKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'SegmentKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Lift Status Error: description: Example error when lift status is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidLiftStatus message: Updating verified travel documents requires the passenger to have a lift status of checked in or boarded. Lift status for passenger JoKwkYODu4gNYRwNQo is currently Default. type: Validation details: null 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 Invalid Document Type Error: description: Example error when document type is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidDocumentType message: The document type code 'INVALID' is invalid or inactive. type: Validation details: null 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 Invalid Issued by Code Error: description: Example error when document issued by code is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidIssuedByCode message: The issued by code 'INVALID' is invalid or inactive. type: Validation details: null 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 ? /api/dcs/v1/verifiedTravelDocuments/{recordLocator}/segments/{segmentKey}/passengers/{passengerKey}/documents/{documentKey} : post: tags: - verifiedTravelDocuments summary: Adds a new verified travel document to a passenger or the associated infant by the document key. description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance problems.` The following items are required to use this endpoint. Agent permissions. Government Security Drivers need to be enabled under government security configurations. Government Security Drivers need to be configured to approve the given document type. The given document must be a document type approved by customs. The target passenger must be either checked in or boarded on the target segment. Due to the nature of this endpoint there is no data returned. To confirm successful update you can find an entry in the booking history using `/api/nsk/v1/bookings/{bookingKey}/history` or view passenger segment information by pulling the booking using `/api/nsk/v1/bookings/{recordLocator}` GraphQL endpoint: verifiedTravelDocumentsAddByKey' operationId: dcs_v1_verifiedTravelDocuments_recordLocator_segments_segmentKey_passengers_passengerKey_documents_documentKey_post parameters: - name: recordLocator in: path required: true description: The record locator of the target booking. schema: type: string x-position: 1 - name: segmentKey in: path required: true description: The target segment key. schema: type: string x-position: 2 - name: passengerKey in: path required: true description: The target passenger key. schema: type: string x-position: 3 - name: documentKey in: path required: true description: The document key of the document you would like to verify. schema: type: string x-position: 4 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Record Locator Error: description: Example error when record locator is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: recordLocator: 9SkFNRegdQRYuQ3YfA2g9 rawMessage: The identifier 'RecordLocator' with value '9SkFNRegdQRYuQ3YfA2g9' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Passenger Key Error: description: Example error when passenger key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: passengerKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'PassengerKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Segment Key Error: description: Example error when segment key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: nsk:Exceptions:InvalidKey type: Validation details: segmentKey: JoKwkYODu4gNYRwNQo rawMessage: The identifier 'SegmentKey' with value 'JoKwkYODu4gNYRwNQo' is invalid. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Lift Status Error: description: Example error when lift status is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidLiftStatus message: Updating verified travel documents requires the passenger to have a lift status of checked in or boarded. Lift status for passenger JoKwkYODu4gNYRwNQo is currently Default. type: Validation details: null 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 Invalid Document Type Error: description: Example error when document type is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidDocumentType message: The document type code 'INVALID' is invalid or inactive. type: Validation details: null 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 Invalid Issued by Code Error: description: Example error when document issued by code is invalid. value: errors: - id: null code: dcs:VerifiedTravelDocuments:InvalidIssuedByCode message: The issued by code 'INVALID' is invalid or inactive. type: Validation details: null 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 /api/nsk/v1/voucherIssuance: post: tags: - voucherIssuance summary: Creates vouchers based upon data in the request. description: 'This endpoint requires agent permissions. Note that creating high volume voucher issuance results in a batch job which may not process immediately. GraphQL endpoint: voucherIssuanceAdd' operationId: nsk_v1_voucherIssuance_post requestBody: x-name: request description: The voucher issuance request. content: application/json: schema: $ref: '#/components/schemas/VoucherIssuanceRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Agent not allowed to issue voucher: description: Example response when issuing vouchers using an agent that is not allowed to issue vouchers. value: errors: - id: null code: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed message: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed type: Validation details: voucherConfigurationCode: VOUCH1 voucherWarningMessage: Agent is not authorized to create any vouchers. rawMessage: The request to issue vouchers has failed. Check user permissions or see voucher configuration 'VOUCH1' to verify the voucher issuance requirements. 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 Voucher configuration restricted for the agent: description: Example response when an agent issues vouchers under a restricted voucher configuration. value: errors: - id: null code: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed message: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed type: Validation details: voucherConfigurationCode: VOUCH2 voucherWarningMessage: Agent is not authorized to create vouchers with voucher basis code VOUCH2. rawMessage: The request to issue vouchers has failed. Check user permissions or see voucher configuration 'VOUCH2' to verify the voucher issuance requirements. 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 Voucher configuration is disabled: description: Example response when an agent issues vouchers under a disabled voucher configuration. value: errors: - id: null code: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed message: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed type: Validation details: voucherConfigurationCode: VOUCH3 voucherWarningMessage: Cannot create vouchers for disabled voucher basis (VOUCH3). rawMessage: The request to issue vouchers has failed. Check user permissions or see voucher configuration 'VOUCH3' to verify the voucher issuance requirements. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With null request: description: Example response when attempting to call the endpoint with null request value: errors: - id: null code: core:Validation:NullRequest message: core:Validation:NullRequest type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. 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 deprecated: true /api/nsk/v2/voucherIssuance: post: tags: - voucherIssuance summary: Creates vouchers based upon data in the request. description: 'This endpoint requires agent permissions. Note that creating high volume voucher issuance results in a batch job which may not process immediately. GraphQL endpoint: voucherIssuanceAdd' operationId: nsk_v2_voucherIssuance_post requestBody: x-name: request description: The voucher issuance request. content: application/json: schema: $ref: '#/components/schemas/VoucherIssuanceRequest' examples: Issue Voucher: description: Example request for issuing a voucher. value: recordLocator: PNRPNR firstName: John lastName: Doe personKey: MUNzPRfx quantity: 1 customerNumber: '10000000000000000001' sendFiles: true ssrCode: WCHR configurationCode: APIMKT issuanceReasonCode: VRA note: Voucher Issuance market: destination: BOS origin: SLC departureDate: '2026-07-09T05:55:14.5590145Z' identifier: '5600' carrierCode: NV opSuffix: null expiration: '2027-07-09T05:55:14.5590644Z' currencyCode: USD amount: 1.0 required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfReducedVoucherResponse' examples: Create Voucher Successful: description: Example when voucher is created successfully value: data: references: - '10000000000000000' issuanceKey: Nzgz0TQhQ1JH '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Agent not allowed to issue voucher: description: Example response when issuing vouchers using an agent that is not allowed to issue vouchers. value: errors: - id: null code: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed message: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed type: Validation details: voucherConfigurationCode: VOUCH1 voucherWarningMessage: Agent is not authorized to create any vouchers. rawMessage: The request to issue vouchers has failed. Check user permissions or see voucher configuration 'VOUCH1' to verify the voucher issuance requirements. 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 Voucher configuration restricted for the agent: description: Example response when an agent issues vouchers under a restricted voucher configuration. value: errors: - id: null code: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed message: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed type: Validation details: voucherConfigurationCode: VOUCH2 voucherWarningMessage: Agent is not authorized to create vouchers with voucher basis code VOUCH2. rawMessage: The request to issue vouchers has failed. Check user permissions or see voucher configuration 'VOUCH2' to verify the voucher issuance requirements. 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 Voucher configuration is disabled: description: Example response when an agent issues vouchers under a disabled voucher configuration. value: errors: - id: null code: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed message: nsk:VoucherIssuanceResponse:VoucherIssuanceFailed type: Validation details: voucherConfigurationCode: VOUCH3 voucherWarningMessage: Cannot create vouchers for disabled voucher basis (VOUCH3). rawMessage: The request to issue vouchers has failed. Check user permissions or see voucher configuration 'VOUCH3' to verify the voucher issuance requirements. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null With null request: description: Example response when attempting to call the endpoint with null request value: errors: - id: null code: core:Validation:NullRequest message: core:Validation:NullRequest type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/voucherIssuance/{voucherIssuanceKey}: get: tags: - voucherIssuance summary: Gets a voucher issuance based upon the voucher issuance key. description: 'This endpoint requires agent permissions. GraphQL endpoint: voucherIssuance' operationId: nsk_v1_voucherIssuance_voucherIssuanceKey_get parameters: - name: voucherIssuanceKey in: path required: true description: The voucher issuance key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherIssuance' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/vouchers: get: tags: - vouchers summary: Gets vouchers based upon data in the request. description: "This endpoint requires agent permissions.\nOnly vouchers from\ \ the agent's non-restricted voucher configurations will be returned. To check\ \ which voucher\nconfigurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes\ \ endpoint.\nIf given a date, one of the following properties are required:\n\ - CustomerName.LastName\n- CustomerNumber\n- Agent\n\t- Agent.Name\n\t- Agent.Domain\n\ If only the begin date is given, the default value of the end date will be\ \ the day after the begin date.\nIf only the end date is given, the begin\ \ date will be required.\nIf at least one of the market properties is provided,\ \ all the other market properties are required.\nIf at least one of the agent\ \ properties is provided, the other agent property is required.\nIf the customer\ \ first name is provided, the customer last name is required.\n\nGraphQL endpoint:\ \ vouchersv3" operationId: nsk_v2_vouchers_get parameters: - name: VoucherIssuanceKey in: query description: "The unique voucher issuance key.\n " schema: type: string nullable: true x-position: 1 - name: Market.Destination in: query description: "Gets or sets the leg arrival station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: Market.Origin in: query description: "Gets or sets the leg departure station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 3 - name: Market.DepartureDate in: query description: "The departure date.\n " schema: type: string format: date-time nullable: true x-position: 4 - name: Market.Identifier in: query description: "The unique transportation identifier.\n " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 5 - name: Market.CarrierCode in: query description: "The carrier code.\n " schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 6 - name: Market.OpSuffix in: query description: "The op suffix.\nPlease note that this should be a char and not\ \ a string.\n " schema: type: string maxLength: 1 nullable: true x-position: 7 - name: Agent.Name in: query description: "The agent name associated with the voucher.\n " schema: type: string maxLength: 64 minLength: 0 nullable: true x-position: 8 - name: Agent.Domain in: query description: "The domain code associated with the voucher.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 9 - name: BeginDate in: query description: "The starting date.\n " schema: type: string format: date-time nullable: true x-position: 10 - name: EndDate in: query description: "The ending date.\n " schema: type: string format: date-time nullable: true x-position: 11 - name: PageSize in: query description: "The Page Size, Default 1000\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 12 - name: LastPageKey in: query description: "The LastPageKey, where to start paged query.\n " schema: type: string nullable: true x-position: 13 - name: SortCriteria in: query description: "Defines the criteria in which the find vouchers result can be\ \ sorted. Defaults to `CreatedDateAscending` if not specified or invalid.\n\ \ \nEnumeration values: 0 = CreatedDateAscending, 1 = Name,\ \ 2 = CreatedDateDescending" schema: nullable: true $ref: '#/components/schemas/FindVoucherSortCriteria' x-position: 14 - name: RecordLocator in: query description: "The record locator associated with the voucher.\n \ \ " schema: type: string maxLength: 12 minLength: 0 nullable: true x-position: 15 - name: CustomerName.FirstName in: query description: "The first name associated with the voucher.\n " schema: type: string maxLength: 64 minLength: 0 nullable: true x-position: 16 - name: CustomerName.LastName in: query description: "The last name associated with the voucher.\n " schema: type: string maxLength: 64 minLength: 0 nullable: true x-position: 17 - name: CustomerNumber in: query description: "The customer number associated with the voucher.\n \ \ " schema: type: string maxLength: 20 minLength: 0 nullable: true x-position: 18 - name: ActiveOnly in: query description: "The flag to indicate if only active items should be returned.\n\ \ " schema: type: boolean x-position: 19 - name: CultureCode in: query description: "The culture code of the paged request.\n " schema: type: string maxLength: 17 minLength: 0 nullable: true x-position: 20 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedVouchersResponse' examples: Retrieve Vouchers: description: Successful retrieval of vouchers value: data: lastPageKey: MTAwMA-- totalCount: 3 vouchers: - createdDate: '2026-07-09T05:55:14.5486216+00:00' voucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx reference: '10011707041300001' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 - createdDate: '2026-07-09T05:55:14.548623+00:00' voucherKey: QYB3NsFyNUdlSRXyNBXsAyB4JLMyZSFyNEBy reference: '10011707041300002' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 - createdDate: '2026-07-09T05:55:14.5486233+00:00' voucherKey: TBS3NlFzLPdyLDRnNDCyMfB4NFFyNjBzFAGg reference: '10011707041300003' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 Invalid Sort Criteria: description: The provided sort criteria is invalid or not defined in the system. value: messages: - code: core:Validation:MalformedRequest type: Information value: The value 'CreatedTime' is invalid. status: 1 details: null data: lastPageKey: MTAwMA-- totalCount: 1 vouchers: - createdDate: '2026-07-09T05:55:14.5486252+00:00' voucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx reference: '10011707041300001' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: All matching vouchers are restricted to the agent: description: Example response when all the vouchers that satisfies the search query belongs to the agent's restricted voucher configuration value: errors: - id: null code: nsk-server:AuthorizationSearchVoucherNotAllowed message: nsk-server:AuthorizationSearchVoucherNotAllowed type: Validation details: message: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. rawMessage: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. 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 No filters specified: description: Example response when no filters are specified. value: errors: - id: null code: nsk-server:VoucherNotFound message: nsk-server:VoucherNotFound type: Validation details: null rawMessage: 'Please specify any of the search criteria: Voucher Details/Passenger Details/Record Locator/Flight Details/Agent Details.' 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 At least one of the market properties is specified and no destination is specified: description: Example response when at least one of the market properties is specified and the destination is set to null or an empty string. value: errors: - id: null code: VoucherMarketInformation.Destination:RequiredAttribute message: VoucherMarketInformation.Destination:RequiredAttribute type: Validation details: validation: RequiredAttribute model: VoucherMarketInformation member: Destination rawMessage: The VoucherMarketInformation field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null At least one of the market properties is specified and no origin is specified: description: Example response when at least one of the market properties is specified and the origin is set to null or an empty string. value: errors: - id: null code: VoucherMarketInformation.Origin:RequiredAttribute message: VoucherMarketInformation.Origin:RequiredAttribute type: Validation details: validation: RequiredAttribute model: VoucherMarketInformation member: Origin rawMessage: The VoucherMarketInformation field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null At least one of the market properties is specified and no departure date is specified: description: Example response when at least one of the market properties is specified and the departure date is set to null. value: errors: - id: null code: VoucherMarketInformation.DepartureDate:RequiredAttribute message: VoucherMarketInformation.DepartureDate:RequiredAttribute type: Validation details: validation: RequiredAttribute model: VoucherMarketInformation member: DepartureDate rawMessage: The VoucherMarketInformation field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null At least one of the market properties is specified and no identifier is specified: description: Example response when at least one of the market properties is specified and the identifier is set to null or an empty string. value: errors: - id: null code: VoucherMarketInformation.Identifier:RequiredAttribute message: VoucherMarketInformation.Identifier:RequiredAttribute type: Validation details: validation: RequiredAttribute model: VoucherMarketInformation member: Identifier rawMessage: The VoucherMarketInformation field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null At least one of the market properties is specified and no carrier code is specified: description: Example response when at least one of the market properties is specified and the carrier code is set to null or an empty string. value: errors: - id: null code: VoucherMarketInformation.CarrierCode:RequiredAttribute message: VoucherMarketInformation.CarrierCode:RequiredAttribute type: Validation details: validation: RequiredAttribute model: VoucherMarketInformation member: CarrierCode rawMessage: The VoucherMarketInformation field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Agent name is specified and agent domain is not specified: description: Example response when the agent name is specified and the agent domain is set to null or an empty string. value: errors: - id: null code: Agent.Domain:RequiredAttribute message: Agent.Domain:RequiredAttribute type: Validation details: validation: RequiredAttribute model: Agent member: Domain rawMessage: The Agent field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Agent domain is specified and agent name is not specified: description: Example response when the agent domain is specified and the agent name is set to null or an empty string. value: errors: - id: null code: Agent.Name:RequiredAttribute message: Agent.Name:RequiredAttribute type: Validation details: validation: RequiredAttribute model: Agent member: Name rawMessage: The Agent field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Customer first name is specified and customer last name is not specified: description: Example response when the customer first name is specified and the customer last name is set to null or an empty string. value: errors: - id: null code: CustomerName.LastName:RequiredAttribute message: CustomerName.LastName:RequiredAttribute type: Validation details: validation: RequiredAttribute model: CustomerName member: LastName rawMessage: The CustomerName field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End date is specified and begin date is not specified: description: Example response when end date is specified and begin date is null. value: errors: - id: null code: nsk:Voucher:VoucherBeginDateRequired message: nsk:Voucher:VoucherBeginDateRequired type: Validation details: beginDate: null rawMessage: Voucher creation begin date is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null End date is earlier than begin date: description: Example response when the end date is earlier than the begin date. value: errors: - id: null code: nsk:EndDate:EndDateBeforeBeginDate message: nsk:EndDate:EndDateBeforeBeginDate type: Validation details: null rawMessage: The requested end date of 4/29/2025 occurs before the requested begin date of 4/30/2025. 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 Begin date or end date is specified but customer name, customer number, agent name, and agent domain is not specified: description: Example response when the Begin date or end date is specified but customer name, customer number, agent name, and agent domain is set to null or an empty string. value: errors: - id: null code: nsk:Voucher:VoucherSearchRequirementsUnmet message: nsk:Voucher:VoucherSearchRequirementsUnmet type: Validation details: customerName: null customerNumber: null agentName: null agentDomainCode: null rawMessage: 'Requirements unmet: Enter one - Customer Name, Customer Number or Agent Name.' 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 deprecated: true /api/nsk/v1/vouchers/{voucherKey}: get: tags: - vouchers summary: Gets a specific voucher based upon the voucher key. description: 'This endpoint requires agent permissions. GraphQL endpoint: voucher' operationId: nsk_v1_vouchers_voucherKey_get parameters: - name: voucherKey in: path required: true description: The voucher key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucher' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - vouchers summary: Changes the voucher status, type, or expiration date. description: 'This endpoint requires agent permissions. Due to system limitations only one field can be updated per call. Voucher types of 0 and 2 (Credit and Service) have been removed from the request for this endpoint as they are not valid type to be updated to. GraphQL endpoint: voucherModify' operationId: nsk_v1_vouchers_voucherKey_patch parameters: - name: voucherKey in: path required: true description: The voucher key schema: type: string x-position: 1 requestBody: x-name: request description: The voucher update request. content: application/json: schema: $ref: '#/components/schemas/VoucherUpdateRequestv2' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Multiple field update: description: Example error if more than one field is being updated value: errors: - id: null code: nsk-server:Vouchers message: Changing VoucherType when changing the Status on a Voucher to Void is not supported type: Error details: voucherWarningMessage: Changing VoucherType when changing the Status on a Voucher to Void is not supported 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. - id: null code: nsk-server:Vouchers message: Changing ExpirationDate when changing the Status on a Voucher to Void is not supported type: Error details: voucherWarningMessage: Changing ExpirationDate when changing the Status on a Voucher to Void is not supported 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. - id: null code: nsk-server:Vouchers message: Changing VoucherType when reinstating a Voucher is not supported type: Error details: voucherWarningMessage: Changing VoucherType when reinstating a Voucher is not supported 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. - id: null code: nsk-server:Vouchers message: Changing ExpirationDate when reinstating a Voucher is not supported type: Error details: voucherWarningMessage: Changing ExpirationDate when reinstating a Voucher is not supported 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. - id: null code: nsk-server:Vouchers message: Changing the Status of a Voucher when extending the ExpirationDate is not supported type: Error details: voucherWarningMessage: Changing the Status of a Voucher when extending the ExpirationDate is not supported 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. - id: null code: nsk-server:Vouchers message: Changing the VoucherType of a Voucher when extending the ExpirationDate is not supported type: Error details: voucherWarningMessage: Changing the VoucherType of a Voucher when extending the ExpirationDate is not supported 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. - id: null code: nsk-server:Vouchers message: Changing the Status of a Voucher when changing the VoucherType is not supported type: Error details: voucherWarningMessage: Changing the Status of a Voucher when changing the VoucherType is not supported 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. - id: null code: nsk-server:Vouchers message: Changing ExpirationDate of a Voucher when changing a VoucherType is not supported type: Error details: voucherWarningMessage: Changing ExpirationDate of a Voucher when changing a VoucherType is not supported 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 Invalid voucher type: description: Example error if an invalid voucher type is used value: errors: - id: null code: nsk:Exceptions:OutOfRange message: 'The value ''2'' is out of range for ''VoucherUpdateRequestv2.Type''.Expected values: (1,3,4,5,6)' type: Validation details: null 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 /api/nsk/v1/vouchers/{voucherKey}/owner: patch: tags: - vouchers summary: Changes the voucher owner. description: 'This endpoint requires agent permissions. If the personKey is populated, the voucher owner''s first and last name will be updated to match what corresponds with the person. If no personKey is given, the names in the request will be used to update the voucher. Additionally, there are configuration restrictions to be able to use this endpoint. First, the voucher must be allowed to be used by the Agent, under Booking Payments Codes -> Voucher Basis Codes. Second, the voucher basis must have usage type "Match On Passenger Name" or "Match on Passenger or Contact Name". Related endpoints: - GET /api/nsk/v2/vouchers: Lookup vouchers. Agent Only. - GET /api/nsk/v1/vouchers/{voucherKey}: Get a specific voucher. GraphQL endpoint: voucherOwnerModify' operationId: nsk_v1_vouchers_voucherKey_owner_patch parameters: - name: voucherKey in: path required: true description: The voucher key schema: type: string x-position: 1 requestBody: x-name: request description: The voucher update request. content: application/json: schema: $ref: '#/components/schemas/VoucherOwnerUpdateRequest' examples: Update Voucher Owner Person Key Only: description: Example request for when wanting to update the voucher owner of a voucher based on a person key. You can simply not set the First Name and Last Name on the request and those will be set internally. value: personKey: MUNzPRfx firstName: null lastName: null Update Voucher Owner with First and Last Name Only: description: Example request for when wanting to update the voucher owner's first and last name without associating with a person key. value: personKey: null firstName: Jim lastName: Bob Update Voucher Owner with Person Key and Names: description: Example request for when wanting to update the voucher owner of a voucher based on a person key. You can set FirstName and LastName, but if they don't match the Person they will be overriden. value: personKey: MUNzPRfx firstName: FirstNameMatchesPerson lastName: LastNameMatchesPerson required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Failure to Update Voucher Owner Because Transferable.: description: Example error for when unable to update the voucher owner of a voucher that is transferable. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'Voucher' has failed. Please verify this object exists. 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. messages: - rawValue: null code: nsk:Voucher:VoucherValidationWarning debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: VoucherValidation value: Unable to update the owner of a transferable voucher. status: 1 details: voucherWarningMessage: Unable to update the owner of a transferable voucher. data: null Failure to Update Voucher Owner: description: Example error for when no changes were made to the voucher. value: errors: - id: null code: nsk:Exceptions:UpdateFailed message: nsk:Exceptions:UpdateFailed type: Validation details: null rawMessage: Attempted update of object 'Voucher' has failed. Please verify this object exists. 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. messages: - rawValue: null code: nsk:Voucher:VoucherValidationWarning debugMode: The API is currently running in debug mode. In production the 'rawValue' node will not be returned. These are for troubleshooting development issues only. type: VoucherValidation value: No changes were made to the voucher details. status: 1 details: voucherWarningMessage: No changes were made to the voucher details. data: null /api/nsk/v2/vouchers/byAgent: get: tags: - vouchers summary: Gets a collection of vouchers based on the specified agent information. description: 'This endpoint requires agent permissions. Only vouchers from the agent''s non-restricted voucher configurations will be returned. To check which voucher configurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes endpoint. GraphQL endpoint: vouchersByAgentv2' operationId: nsk_v2_vouchers_byAgent_get parameters: - name: Name in: query description: "The agent name associated with the voucher.\n " schema: type: string maxLength: 64 minLength: 0 nullable: true x-position: 1 - name: Domain in: query description: "The domain code associated with the voucher.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: BeginDate in: query description: "The starting date.\n " schema: type: string format: date-time nullable: true x-position: 3 - name: EndDate in: query description: "The ending date.\n " schema: type: string format: date-time nullable: true x-position: 4 - name: PageSize in: query description: "The Page Size, Default 1000\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 5 - name: LastPageKey in: query description: "The LastPageKey, where to start paged query.\n " schema: type: string nullable: true x-position: 6 - name: SortCriteria in: query description: "Defines the criteria in which the find vouchers result can be\ \ sorted. Defaults to `CreatedDateAscending` if not specified or invalid.\n\ \ \nEnumeration values: 0 = CreatedDateAscending, 1 = Name,\ \ 2 = CreatedDateDescending" schema: nullable: true $ref: '#/components/schemas/FindVoucherSortCriteria' x-position: 7 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedVouchersResponse' examples: Retrieve Vouchers: description: Successful retrieval of vouchers value: data: lastPageKey: MTAwMA-- totalCount: 3 vouchers: - createdDate: '2026-07-09T05:55:14.5536046+00:00' voucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx reference: '10011707041300001' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 - createdDate: '2026-07-09T05:55:14.5536059+00:00' voucherKey: QYB3NsFyNUdlSRXyNBXsAyB4JLMyZSFyNEBy reference: '10011707041300002' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 - createdDate: '2026-07-09T05:55:14.5536062+00:00' voucherKey: TBS3NlFzLPdyLDRnNDCyMfB4NFFyNjBzFAGg reference: '10011707041300003' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 Invalid Sort Criteria: description: The provided sort criteria is invalid or not defined in the system. value: messages: - code: core:Validation:MalformedRequest type: Information value: The value 'CreatedTime' is invalid. status: 1 details: null data: lastPageKey: MTAwMA-- totalCount: 1 vouchers: - createdDate: '2026-07-09T05:55:14.5536088+00:00' voucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx reference: '10011707041300001' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: All matching vouchers are restricted to the agent: description: Example response when all the vouchers that satisfies the search query belongs to the agent's restricted voucher configuration value: errors: - id: null code: nsk-server:AuthorizationSearchVoucherNotAllowed message: nsk-server:AuthorizationSearchVoucherNotAllowed type: Validation details: message: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. rawMessage: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v1/vouchers/byDate: get: tags: - vouchers summary: Searches for vouchers issued within the given date range. description: 'This endpoint requires agent permissions. Only vouchers from the agent''s non-restricted voucher configurations will be returned. To check which voucher configurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes endpoint. GraphQL endpoint: vouchersByDate' operationId: nsk_v1_vouchers_byDate_get parameters: - name: PageSize in: query description: "The number of items to return.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 1 - name: LastPageKey in: query description: "The key returned previously to get the next page of items.\n\ \ " schema: type: string nullable: true x-position: 2 - name: BeginDate in: query description: "The starting date.\n " schema: type: string format: date-time nullable: true x-position: 3 - name: EndDate in: query description: "The ending date.\n " schema: type: string format: date-time nullable: true x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVouchersSummaryResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: All matching vouchers are restricted to the agent: description: Example response when all the vouchers that satisfies the search query belongs to the agent's restricted voucher configuration value: errors: - id: null code: nsk-server:AuthorizationSearchVoucherNotAllowed message: nsk-server:AuthorizationSearchVoucherNotAllowed type: Validation details: message: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. rawMessage: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/vouchers/byIssuance/{voucherIssuanceKey}: get: tags: - vouchers summary: Gets vouchers associated with a voucher issuance. description: 'This endpoint requires agent permissions. Only vouchers from the agent''s non-restricted voucher configurations will be returned. To check which voucher configurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes endpoint. GraphQL endpoint: vouchersByIssuancev2' operationId: nsk_v2_vouchers_byIssuance_voucherIssuanceKey_get parameters: - name: voucherIssuanceKey in: path required: true description: The voucher issuance key. schema: type: string x-position: 1 - name: PageSize in: query description: "The Page Size, Default 1000\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 2 - name: LastPageKey in: query description: "The LastPageKey, where to start paged query.\n " schema: type: string nullable: true x-position: 3 - name: sortCriteria in: query description: "Indicates how the search results will be sorted. Defaults to\ \ `CreatedDate` if not specified\nor invalid.\n \nEnumeration\ \ values: 0 = CreatedDateAscending, 1 = Name, 2 = CreatedDateDescending" schema: $ref: '#/components/schemas/FindVoucherSortCriteria' x-position: 4 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedVouchersResponse' examples: Retrieve Vouchers: description: Successful retrieval of vouchers value: data: lastPageKey: MTAwMA-- totalCount: 3 vouchers: - createdDate: '2026-07-09T05:55:14.5557974+00:00' voucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx reference: '10011707041300001' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 - createdDate: '2026-07-09T05:55:14.5557986+00:00' voucherKey: QYB3NsFyNUdlSRXyNBXsAyB4JLMyZSFyNEBy reference: '10011707041300002' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 - createdDate: '2026-07-09T05:55:14.5557989+00:00' voucherKey: TBS3NlFzLPdyLDRnNDCyMfB4NFFyNjBzFAGg reference: '10011707041300003' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 Invalid Sort Criteria: description: The provided sort criteria is invalid or not defined in the system. value: messages: - code: core:Validation:MalformedRequest type: Information value: The value 'CreatedTime' is invalid. status: 1 details: null data: lastPageKey: MTAwMA-- totalCount: 1 vouchers: - createdDate: '2026-07-09T05:55:14.5558002+00:00' voucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx reference: '10011707041300001' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: All matching vouchers are restricted to the agent: description: Example response when all the vouchers that satisfies the search query belongs to the agent's restricted voucher configuration value: errors: - id: null code: nsk-server:AuthorizationSearchVoucherNotAllowed message: nsk-server:AuthorizationSearchVoucherNotAllowed type: Validation details: message: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. rawMessage: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null /api/nsk/v2/vouchers/byMarket: get: tags: - vouchers summary: Gets a collection of vouchers based on the market information. description: 'This endpoint requires agent permissions. Only vouchers from the agent''s non-restricted voucher configurations will be returned. To check which voucher configurations are allowed, kindly use the GET /api/nsk/v1/settings/booking/paymentCodes endpoint. GraphQL endpoint: vouchersByMarketv2' operationId: nsk_v2_vouchers_byMarket_get parameters: - name: Destination in: query description: "Gets or sets the leg arrival station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 1 - name: Origin in: query description: "Gets or sets the leg departure station.\n " schema: type: string maxLength: 3 minLength: 0 nullable: true x-position: 2 - name: DepartureDate in: query description: "The departure date.\n " schema: type: string format: date-time nullable: true x-position: 3 - name: Identifier in: query description: "The unique transportation identifier.\n " schema: type: string maxLength: 4 minLength: 0 nullable: true x-position: 4 - name: CarrierCode in: query description: "The carrier code.\n " schema: type: string maxLength: 3 minLength: 2 nullable: true x-position: 5 - name: OpSuffix in: query description: "The op suffix.\nPlease note that this should be a char and not\ \ a string.\n " schema: type: string maxLength: 1 nullable: true x-position: 6 - name: PageSize in: query description: "The Page Size, Default 1000\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 7 - name: LastPageKey in: query description: "The LastPageKey, where to start paged query.\n " schema: type: string nullable: true x-position: 8 - name: SortCriteria in: query description: "Defines the criteria in which the find vouchers result can be\ \ sorted. Defaults to `CreatedDateAscending` if not specified or invalid.\n\ \ \nEnumeration values: 0 = CreatedDateAscending, 1 = Name,\ \ 2 = CreatedDateDescending" schema: nullable: true $ref: '#/components/schemas/FindVoucherSortCriteria' x-position: 9 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedVouchersResponse' examples: Retrieve Vouchers: description: Successful retrieval of vouchers value: data: lastPageKey: MTAwMA-- totalCount: 3 vouchers: - createdDate: '2026-07-09T05:55:14.5378024+00:00' voucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx reference: '10011707041300001' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 - createdDate: '2026-07-09T05:55:14.5378264+00:00' voucherKey: QYB3NsFyNUdlSRXyNBXsAyB4JLMyZSFyNEBy reference: '10011707041300002' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 - createdDate: '2026-07-09T05:55:14.5378267+00:00' voucherKey: TBS3NlFzLPdyLDRnNDCyMfB4NFFyNjBzFAGg reference: '10011707041300003' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 Invalid Sort Criteria: description: The provided sort criteria is invalid or not defined in the system. value: messages: - code: core:Validation:MalformedRequest type: Information value: The value 'CreatedTime' is invalid. status: 1 details: null data: lastPageKey: MTAwMA-- totalCount: 1 vouchers: - createdDate: '2026-07-09T05:55:14.537843+00:00' voucherKey: NTA2MiExMTcwITEwMDExNzA3MDQxMzAwMDAx reference: '10011707041300001' configurationCode: NOREQ status: 0 available: 1000.0 firstName: John lastName: Doe personKey: MUNzPRfx voucherIssuanceKey: MTE3MCFHQkFUQ0g- expiration: '9999-12-31T23:59:59.9999999' currencyCode: USD amount: 1000.0 '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: All matching vouchers are restricted to the agent: description: Example response when all the vouchers that satisfies the search query belongs to the agent's restricted voucher configuration value: errors: - id: null code: nsk-server:AuthorizationSearchVoucherNotAllowed message: nsk-server:AuthorizationSearchVoucherNotAllowed type: Validation details: message: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. rawMessage: Agent is not authorized to search restricted voucher reference numbers with voucher basis code(s) NOREQ. 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 No destination specified: description: Example response when the destination is set to null or an empty string. value: errors: - id: null code: VoucherMarketInformationv2.Destination:RequiredAttribute message: The VoucherMarketInformationv2 field is required. type: Validation details: validation: RequiredAttribute model: VoucherMarketInformationv2 member: Destination rawMessage: The VoucherMarketInformationv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null No origin specified: description: Example response when the origin is set to null or an empty string. value: errors: - id: null code: VoucherMarketInformationv2.Origin:RequiredAttribute message: The VoucherMarketInformationv2 field is required. type: Validation details: validation: RequiredAttribute model: VoucherMarketInformationv2 member: Origin rawMessage: The VoucherMarketInformationv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null No departure date specified: description: Example response when the departure date is set to null. value: errors: - id: null code: VoucherMarketInformationv2.DepartureDate:RequiredAttribute message: The VoucherMarketInformationv2 field is required. type: Validation details: validation: RequiredAttribute model: VoucherMarketInformationv2 member: DepartureDate rawMessage: The VoucherMarketInformationv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null No identifier specified: description: Example response when the identifier is set to null or an empty string. value: errors: - id: null code: VoucherMarketInformationv2.Identifier:RequiredAttribute message: The VoucherMarketInformationv2 field is required. type: Validation details: validation: RequiredAttribute model: VoucherMarketInformationv2 member: Identifier rawMessage: The VoucherMarketInformationv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null No carrier code specified: description: Example response when the carrier code is set to null or an empty string. value: errors: - id: null code: VoucherMarketInformationv2.CarrierCode:RequiredAttribute message: The VoucherMarketInformationv2 field is required. type: Validation details: validation: RequiredAttribute model: VoucherMarketInformationv2 member: CarrierCode rawMessage: The VoucherMarketInformationv2 field is required. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/vouchers/byReference/{voucherReferenceNumber}: get: tags: - vouchers summary: Gets a specific voucher based upon the voucher reference number. description: 'This endpoint requires agent permissions. If you are not seeing a voucher reference number, and you are expecting to, make sure that voucher masking is turned off or that you have permissions to view voucher reference numbers. GraphQL endpoint: voucherByReferenceNumber' operationId: nsk_v1_vouchers_byReference_voucherReferenceNumber_get parameters: - name: voucherReferenceNumber in: path required: true description: The voucher reference number. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherReference' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/vouchers/configuration: get: tags: - vouchers summary: Performs a shallow call to get all available voucher configurations. description: 'This endpoint requires agent permissions. Since this performs a shallow call, some voucher configuration list properties come back empty. To get the complete data, use GET `/api/nsk/v1/vouchers/configuration/{configurationCode}` which performs a deep call to get a specific voucher configuration based on the configuration code. GraphQL endpoint: voucherConfigurations' operationId: nsk_v1_vouchers_configuration_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfVoucherConfiguration' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - vouchers summary: Creates a new voucher configuration. description: 'This endpoint requires agent permissions. GraphQL endpoint: addVoucherConfigurations' operationId: nsk_v1_vouchers_configuration_post requestBody: x-name: request description: The voucher configuration request. content: application/json: schema: $ref: '#/components/schemas/VoucherConfigurationRequest' required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherConfiguration' deprecated: true put: tags: - vouchers summary: Updates a voucher configuration. description: 'This endpoint requires agent permissions. When updating the market or travel restrictions, you will need to specify the market or travel restrictions sequence number in order to properly update the associated restriction. In order to add new market or travel restrictions on this endpoint, the sequence number on the restriction needs to be set to `-1` to indicate to NewSkies that it is an added restriction. GraphQL endpoint: setVoucherConfigurations' operationId: nsk_v1_vouchers_configuration_put requestBody: x-name: request description: The voucher configuration request. content: application/json: schema: $ref: '#/components/schemas/VoucherConfigurationRequest' examples: Add Market or Travel Restrictions: description: Example request for when wanting to add market or travel restrictions on an update of a voucher configuration. value: configurationCode: y0z6XR name: Jim Bob description: null type: null issuanceType: null voucherUsageType: 2 tripType: 0 expirationControl: 0 expirationType: null expirationDate: '2026-07-09T05:55:13.4986772+00:00' expirationDays: 0 currencyCode: USD amountControl: 0 calculatedAmountControl: 0 maximumAmount: 0.0 maximumPassengers: 1 maximumVouchersPerBooking: 0 travelDayOfWeekRestriction: null nameRestriction: 0 voucherRequirements: 0 nextReferenceNumber: 0 note: Voucher configuration note maximumAmountIsPerPassenger: false calculatedPercentage: 0.0 issuanceControl: 0 enableVoucherAdjustments: false restrictFlightBatchIssuance: 0 voucherUsageBaseFeeType: 0 issueToRevenuePassengersOnly: false fareClasses: null marketRestrictions: - restrictionType: 0 voucherConfigurationCode: null directionality: 1 sequence: -1 regionType: 2 regionCode: SLC travelRegionType: 2 travelRegionCode: BOS travelRestrictions: - restrictionType: 2 voucherConfigurationCode: null initialTravelDate: '2026-07-09T05:55:13.4988302+00:00' sequence: -1 endTravelDate: '2026-07-14T05:55:13.4988102+00:00' enabled: true Update Market or Travel Restrictions: description: Example request for when wanting to update a market or travel restrictions on an update of a voucher configuration. value: configurationCode: y0z6XR name: Jim Bob description: null type: null issuanceType: null voucherUsageType: 2 tripType: 0 expirationControl: 0 expirationType: null expirationDate: '2026-07-09T05:55:13.4989932+00:00' expirationDays: 0 currencyCode: USD amountControl: 0 calculatedAmountControl: 0 maximumAmount: 0.0 maximumPassengers: 1 maximumVouchersPerBooking: 0 travelDayOfWeekRestriction: null nameRestriction: 0 voucherRequirements: 0 nextReferenceNumber: 0 note: Voucher configuration note maximumAmountIsPerPassenger: false calculatedPercentage: 0.0 issuanceControl: 0 enableVoucherAdjustments: false restrictFlightBatchIssuance: 0 voucherUsageBaseFeeType: 0 issueToRevenuePassengersOnly: false fareClasses: null marketRestrictions: - restrictionType: 0 voucherConfigurationCode: null directionality: 1 sequence: 2 regionType: 2 regionCode: SLC travelRegionType: 2 travelRegionCode: BOS travelRestrictions: - restrictionType: 2 voucherConfigurationCode: null initialTravelDate: '2026-07-09T05:55:13.4989939+00:00' sequence: 1 endTravelDate: '2026-07-14T05:55:13.4989936+00:00' enabled: true required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherConfiguration' deprecated: true delete: tags: - vouchers summary: Deletes a voucher configuration. description: 'This endpoint requires agent permissions. A voucher configuration can only be deleted if no vouchers are associated with it. Otherwise, it cannot be deleted, regardless of the status of the associated vouchers (Active, Redeemed, Void, Expired). GraphQL endpoint: deleteVoucherConfigurations' operationId: nsk_v1_vouchers_configuration_delete requestBody: x-name: request description: The voucher configuration delete request. content: application/json: schema: $ref: '#/components/schemas/VoucherConfigurationDeleteRequest' required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherConfiguration' /api/nsk/v2/vouchers/configuration: post: tags: - vouchers summary: Creates a new voucher configuration. description: 'This endpoint requires agent permissions. GraphQL endpoint: addVoucherConfigurationsv2' operationId: nsk_v2_vouchers_configuration_post requestBody: x-name: request description: The voucher configuration request. content: application/json: schema: $ref: '#/components/schemas/VoucherConfigurationRequestv2' required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherConfiguration' put: tags: - vouchers summary: Updates a voucher configuration. description: 'This endpoint requires agent permissions. When updating the market or travel restrictions, you will need to specify the market or travel restrictions sequence number in order to properly update the associated restriction. In order to add new market or travel restrictions on this endpoint, the sequence number on the restriction needs to be set to `-1` to indicate to NewSkies that it is an added restriction. GraphQL endpoint: setVoucherConfigurationsv2' operationId: nsk_v2_vouchers_configuration_put requestBody: x-name: request description: The voucher configuration request. content: application/json: schema: $ref: '#/components/schemas/VoucherConfigurationRequestv2' examples: Add Market or Travel Restrictions: description: Example request for when wanting to add market or travel restrictions on an update of a voucher configuration. value: configurationCode: y0z6XR name: Jim Bob description: null type: null issuanceType: null voucherUsageTypes: - 5 - 9 - 10 tripType: 0 expirationControl: 0 expirationType: null expirationDate: '2026-07-09T05:55:14.5215377+00:00' expirationDays: 0 currencyCode: USD amountControl: 0 calculatedAmountControl: 0 maximumAmount: 0.0 maximumPassengers: 1 maximumVouchersPerBooking: 0 travelDayOfWeekRestriction: null nameRestriction: 0 voucherRequirements: 0 nextReferenceNumber: 0 note: Voucher configuration note maximumAmountIsPerPassenger: false calculatedPercentage: 0.0 issuanceControl: 0 enableVoucherAdjustments: false restrictFlightBatchIssuance: 0 voucherUsageBaseFeeType: 0 issueToRevenuePassengersOnly: false fareClasses: null marketRestrictions: - restrictionType: 0 voucherConfigurationCode: null directionality: 1 sequence: -1 regionType: 2 regionCode: SLC travelRegionType: 2 travelRegionCode: BOS travelRestrictions: - restrictionType: 2 voucherConfigurationCode: null initialTravelDate: '2026-07-09T05:55:14.5219014+00:00' sequence: -1 endTravelDate: '2026-07-14T05:55:14.5219001+00:00' enabled: true Update Market or Travel Restrictions: description: Example request for when wanting to update a market or travel restrictions on an update of a voucher configuration. value: configurationCode: y0z6XR name: Jim Bob description: null type: null issuanceType: null voucherUsageTypes: - 11 - 12 tripType: 0 expirationControl: 0 expirationType: null expirationDate: '2026-07-09T05:55:14.5219267+00:00' expirationDays: 0 currencyCode: USD amountControl: 0 calculatedAmountControl: 0 maximumAmount: 0.0 maximumPassengers: 1 maximumVouchersPerBooking: 0 travelDayOfWeekRestriction: null nameRestriction: 0 voucherRequirements: 0 nextReferenceNumber: 0 note: Voucher configuration note maximumAmountIsPerPassenger: false calculatedPercentage: 0.0 issuanceControl: 0 enableVoucherAdjustments: false restrictFlightBatchIssuance: 0 voucherUsageBaseFeeType: 0 issueToRevenuePassengersOnly: false fareClasses: null marketRestrictions: - restrictionType: 0 voucherConfigurationCode: null directionality: 1 sequence: 2 regionType: 2 regionCode: SLC travelRegionType: 2 travelRegionCode: BOS travelRestrictions: - restrictionType: 2 voucherConfigurationCode: null initialTravelDate: '2026-07-09T05:55:14.5219275+00:00' sequence: 1 endTravelDate: '2026-07-14T05:55:14.5219274+00:00' enabled: true required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherConfiguration' /api/nsk/v1/vouchers/configuration/{configurationCode}: get: tags: - vouchers summary: Performs a deep call to get a specific voucher configuration based on the configuration code. description: 'This endpoint requires agent permissions. GraphQL endpoint: voucherConfiguration' operationId: nsk_v1_vouchers_configuration_configurationCode_get parameters: - name: configurationCode in: path required: true description: The code of the voucher configuration to retrieve. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfVoucherConfiguration' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/watchList/{watchListKey}/persons: get: tags: - watchList summary: Searches for a collection of watch list persons. description: 'GraphQL endpoint: personsWatchList' operationId: nsk_v1_watchList_watchListKey_persons_get parameters: - name: watchListKey in: path required: true description: The watch list key. schema: type: string x-position: 1 - name: ReferenceNumber in: query description: "The watch list reference number.\n " schema: type: string nullable: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfWatchListPerson' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' deprecated: true /api/nsk/v2/watchList/{watchListKey}/persons: get: tags: - watchList summary: Searches for a collection of watch list persons based on a specific watch list key. description: 'The watch list key is required for this endpoint and will be validated. If it is an invalid watch list key, the API will return a BadRequest. The results returned will be for all persons belonging to the watch list key. This endpoint also supports paging. Please refer to documentation of watch list functionality in Management Console for further guidance and more information. GraphQL endpoint: personsWatchListv2' operationId: nsk_v2_watchList_watchListKey_persons_get parameters: - name: watchListKey in: path required: true description: The watch list key. schema: type: string x-position: 1 - name: ReferenceNumber in: query description: "The watch list reference number.\n " schema: type: string nullable: true x-position: 2 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 3 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 4 responses: '200': description: OK. The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPagedWatchListPersonResponse' examples: Watch list person by key: description: Successful retrieval of persons associated with a watch list by key value: data: persons: - watchListPersonKey: MTAwODYhMTk2 names: - name: first: Digital middle: null last: API title: null suffix: null nameType: 0 dateOfBirth: null addresses: null phoneNumbers: null emails: null payments: null travelDocuments: null information: null comments: null dateOfBirth: '2006-07-09T05:55:14.2019926Z' gender: 1 birthCountry: US nationality: null watchListKey: null declaredGender: null lastPageKey: MTAwMA-- '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: None persons data found: description: Example error when there are no persons records associated with the watch list. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid watch list key: description: Example error where the watch list key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'WatchListKey' with value 'asdf' is invalid. type: Validation details: null 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 Invalid last page key: description: Example error where the page key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'LastPageKey' with value 'P6OfQe11bMStBjI' is invalid. type: Validation details: null 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 Invalid page size: description: Example error where the page size is invalid. value: errors: - id: null code: PagedWatchListPersonRequest.PageSize:RangeAttribute message: The field PagedWatchListPersonRequest must be between 10 and 5000. type: Validation details: validation: RangeAttribute model: PagedWatchListPersonRequest member: PageSize 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 /api/nsk/v1/watchList/persons: get: tags: - watchList summary: Searches for a collection of all watch list persons. description: 'This endpoint is designed to return all person watch list results. The response is organized into a dictionary of watch list key to persons result list, per watch list. It should be noted that, since this endpoint supports paging, results from one watch list may span more than one page. So the end user should watch the paged results to make sure they collect all results from one particular watch list. The returned page key is for all results returned, so should be used as is to get the next set of watch list person results, which will then be organized into individual watch list results. Please refer to documentation of watch list functionality in Management Console for further guidance and more information. GraphQL endpoint: personsWatchListAll' operationId: nsk_v1_watchList_persons_get parameters: - name: ReferenceNumber in: query description: "The watch list reference number.\n " schema: type: string nullable: true x-position: 1 - name: LastPageKey in: query description: "The key of the last booking history item returned.\n \ \ " schema: type: string nullable: true x-position: 2 - name: PageSize in: query description: "The page size for the response.\n " schema: type: integer maximum: 5000.0 minimum: 10.0 nullable: true x-position: 3 responses: '200': description: OK. The request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllPagedWatchListPersonResponse' examples: Watch list person by key: description: Successful retrieval of persons associated with a watch list by key value: data: persons: nw--: - watchListPersonKey: NyExMjE- names: - name: first: Digital middle: null last: API title: null suffix: null nameType: 0 dateOfBirth: null addresses: null phoneNumbers: null emails: null payments: null travelDocuments: null information: null comments: null dateOfBirth: '2006-07-09T05:55:14.1023586Z' gender: 1 birthCountry: US nationality: null watchListKey: Nw-- declaredGender: null mjM-: - watchListPersonKey: MjMhMTg1 names: - name: first: George middle: null last: Washington title: null suffix: null nameType: 0 dateOfBirth: null addresses: null phoneNumbers: null emails: null payments: null travelDocuments: null information: null comments: null dateOfBirth: '1976-07-09T05:55:14.1024316Z' gender: 1 birthCountry: US nationality: null watchListKey: MjM- declaredGender: null - watchListPersonKey: MjMhMTIw names: - name: first: Abraham middle: null last: Lincoln title: null suffix: null nameType: 0 dateOfBirth: null addresses: null phoneNumbers: null emails: null payments: null travelDocuments: null information: null comments: null dateOfBirth: '1982-07-09T05:55:14.1024321Z' gender: 1 birthCountry: US nationality: null watchListKey: MjM- declaredGender: null lastPageKey: MTAwMA-- '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid last page key: description: Example error where the page key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'LastPageKey' with value 'P6OfQe11bMStBjI' is invalid. type: Validation details: null 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 Invalid watch list person key: description: Example error where the watch list person key is invalid. value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'watchListPersonKey' with value 'XgRR97E4' is invalid. type: Validation details: null 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 Invalid page size: description: Example error where the page size is invalid. value: errors: - id: null code: PagedWatchListPersonRequest.PageSize:RangeAttribute message: The field PagedWatchListPersonRequest must be between 10 and 5000. type: Validation details: validation: RangeAttribute model: PagedWatchListPersonRequest member: PageSize 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 '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: None persons data found: description: Example error when there are no persons records associated with the watch list. value: data: null /api/nsk/v1/watchList/persons/{watchListPersonKey}: get: tags: - watchList summary: Gets a specific watch list person by key. description: 'GraphQL endpoint: personWatchList' operationId: nsk_v1_watchList_persons_watchListPersonKey_get parameters: - name: watchListPersonKey in: path required: true description: The watch list person key. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfWatchListPerson' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' components: schemas: IJsonResponseOfPricingConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PricingConfiguration' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PricingConfiguration: type: object description: "Defines the pricing configuration model.\n " additionalProperties: false properties: chargeCode: type: string description: "The charge code to be used for all discount records that will\ \ be added.\n " nullable: true maximumOptimizePercentage: type: number description: "This is the largest sample size active in the service.\n \ \ " format: double settings: type: array description: "The recommendation's settings.\n " nullable: true items: $ref: '#/components/schemas/PricingSetting' providers: type: array description: "The recommendation's providers.\n " nullable: true items: $ref: '#/components/schemas/PricingProvider' PricingSetting: type: object description: "Defines the pricing setting model.\n " additionalProperties: false properties: code: type: string description: "The setting code.\n " nullable: true value: type: string description: "The setting value.\n " nullable: true PricingProvider: type: object description: "Defines the pricing provider model.\n " additionalProperties: false properties: code: type: string description: "The session provider code.\n " nullable: true source: type: string description: "The session provider source.\n " nullable: true inputParameters: type: array description: "The recommendation session input parameters.\n " nullable: true items: type: string products: type: array description: "The recommendation session products.\n " nullable: true items: $ref: '#/components/schemas/PricingProduct' PricingProduct: type: object description: "Defines the pricing product model.\n " additionalProperties: false required: - code properties: code: type: string description: "The pricing product code.\n " maxLength: 36 minLength: 0 variation: type: string description: "The pricing product variation.\n " maxLength: 32 minLength: 0 nullable: true type: type: string description: "The pricing product type.\n " maxLength: 7 minLength: 0 nullable: true ErrorResponse: type: object description: "Defines a unique error response.\n " additionalProperties: false properties: exception: description: "The original exception that was thrown and all the exception\ \ details.\n " nullable: true $ref: '#/components/schemas/Exception' rawMessage: type: string description: "The original raw message set (non-localized).\n \ \ " nullable: true code: type: string description: "The unique error code. The primary value used to match against\ \ a unique message localized for the end user in the\nchosen language.\n\ \ " nullable: true message: type: string description: "The error message. Deprecated: Please use the Code instead.\n\ \ " nullable: true type: type: string description: "The error type showing severity. Values: Critical, Error,\ \ Validation, Information.\n " nullable: true number: type: integer description: "A unique identifier in numeric form. This is required for\ \ Splunk logging. If none is provided a number will be\ngenerated based\ \ on code and type.\n " format: int32 maximum: 99999.0 minimum: 0.0 nullable: true details: type: object description: "Dynamic detailed information about the error.\n \ \ " nullable: true additionalProperties: type: string ActivityId: type: string description: "The activity ID unique to the request. Useful for debugging\ \ purposes to uniquely look up what happened for this\nspecific request.\n\ \ " 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 description: "Defines a unique informational message.\n " additionalProperties: false properties: code: type: string description: "The unique message code.\n " nullable: true type: type: string description: "The message type.\n " nullable: true value: type: string description: "The message's value.\n " nullable: true status: description: "The message's status.\n " $ref: '#/components/schemas/MessageStatus' details: type: object description: "Dynamic detailed information about the message.\n \ \ " nullable: true additionalProperties: type: string MessageStatus: type: integer description: "Defines the message status.\n \n\n0 = General\n1 =\ \ Warning\n2 = Critical" x-enumNames: - General - Warning - Critical enum: - 0 - 1 - 2 MessageDebug: type: object description: "Defines a unique message details.\n " additionalProperties: false properties: code: type: string description: "The unique message code.\n " nullable: true type: type: string description: "The message type.\n " nullable: true value: type: string description: "The message's value.\n " nullable: true status: description: "The message's status.\n " $ref: '#/components/schemas/MessageStatus' details: type: object description: "Dynamic detailed information about the message.\n \ \ " nullable: true additionalProperties: type: string rawValue: type: string description: "The original raw value set (non-localized).\n " nullable: true debugMode: type: string description: "Debug mode warning.\n " nullable: true IJsonResponse: type: object description: "Defines the JSON response contract for a not content type response.\n\ \ " additionalProperties: false properties: data: description: "The payload data, this will always be null for errors responses\ \ and no content responses.\n " nullable: true errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPriceOffer: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PriceOffer' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PriceOffer: type: object description: "Defines the price offer model.\n " additionalProperties: false properties: type: type: string description: "Indicates the type of request that was sent.\n " nullable: true productReference: type: string description: "Used for data mapping for the requested product.\n \ \ " nullable: true price: type: number description: "Contains the optimized price from the APO service.\n \ \ " format: decimal currencyCode: type: string description: "Currency code for the optimized price.\n " nullable: true probability: type: integer description: "The probability computation for the result.\n " format: int32 offerCode: type: string description: "The offer code which gave the optimized price.\n \ \ " nullable: true acceptZero: type: boolean description: "Indicates if the offer accepts a zero price.\n " chargeCode: type: string description: "Indicates the offer's charge code.\n " nullable: true points: type: integer description: "Contains the optimized points from the APO service.\n \ \ " format: int32 outputParameters: type: array description: "The output parameters. Please refer to the NDP/APO documentation\ \ for the output parameters key value pair\nconfiguration.\n \ \ " nullable: true items: $ref: '#/components/schemas/KeyValuePairOfStringAndString' KeyValuePairOfStringAndString: type: object additionalProperties: false properties: key: type: string nullable: true value: type: string nullable: true ApoPriceRequest: type: object description: "Defines the recommend price request model.\n " additionalProperties: false properties: currencyCode: type: string description: "The charge code to be used for all discount records that will\ \ be added.\n " maxLength: 3 minLength: 0 nullable: true passengerType: type: string description: "The passenger type.\n " nullable: true externalBookingReference: type: string description: "The booking reference associated by the selling system for\ \ this transaction. This value is optional,\nas it is for data mapping\ \ purposes only.\n " nullable: true stage: description: "Defines the stage of this transaction.\n " nullable: true $ref: '#/components/schemas/ApoPricingStage' inputParameters: type: array description: "The collection of Input Parameters to be used for this session.\n\ \ " nullable: true items: $ref: '#/components/schemas/PriceInputParameters' valueTypes: type: array description: "Defines the price types to be generated by the system.\n \ \ " nullable: true items: type: string products: type: array description: "Contains the products that will be processed.\n \ \ " nullable: true items: $ref: '#/components/schemas/PriceRequestProduct' ApoPricingStage: type: integer description: "An enumeration to indicate the ancillary pricing options pricing\ \ stage.\n \n\n0 = Look\n1 = Sell\n2 = Book" x-enumNames: - Look - Sell - Book enum: - 0 - 1 - 2 PriceInputParameters: type: object description: "Defines the price request model.\n " additionalProperties: false required: - code properties: code: type: string description: "The input parameter's code.\n " maxLength: 64 minLength: 0 values: type: array description: "The values associated with this input parameter.\n \ \ " nullable: true items: type: string PriceRequestProduct: type: object description: "Defines the price request model.\n " additionalProperties: false required: - productReference - source - provider - code properties: productReference: type: string description: "The product reference, used for data mapping. \nThis is the\ \ RecommendedPriceRequestProduct.ProductKey field in APO\n " minLength: 1 source: type: string description: "The product source. \n " maxLength: 7 minLength: 0 provider: type: string description: "The product provider. \n " maxLength: 7 minLength: 0 code: type: string description: "The pricing product code.\nThis is the RecommendedPriceRequestProduct.ProductCode\ \ field in APO\n " maxLength: 36 minLength: 0 variation: type: string description: "The pricing product variation. \nThis is the RecommendedPriceRequestProduct.ProductVariationCode\ \ field in APO\n " maxLength: 32 minLength: 0 nullable: true type: type: string description: "The pricing product type. \nThis is the RecommendedPriceRequestProduct.ProductTypeCode\ \ field in APO\n " maxLength: 7 minLength: 0 nullable: true originalPrice: type: number description: "The product's original price. \n " format: decimal minimum: 0.0 cost: type: number description: "The product cost. \n " format: decimal available: type: integer description: "The available inventory for this product.\n " format: int32 nullable: true count: type: integer description: "The quantity of this product requested for this session.\n\ \ " format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true segmentProductRatio: type: integer description: "The segment ratio, if available. \n " nullable: true inputParameters: type: array description: "The input parameters associated with this product. \nThis\ \ is the RecommendedPriceRequestProduct.ProductAttributes field in APO\n\ \ " nullable: true items: $ref: '#/components/schemas/PriceInputParameters' IJsonResponseOfEnvironmentHealth: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/EnvironmentHealth' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' EnvironmentHealth: type: object description: "Defines the environment health details.\n " additionalProperties: false properties: component: type: string description: "The name of the component.\n " nullable: true componentType: type: string description: "The type of component.\n " nullable: true details: type: string description: "The optional details of the health check.\n " nullable: true status: description: "The current health of the component.\n " $ref: '#/components/schemas/HealthStatus' nodes: type: array description: "The collection of child health information objects associated\ \ with the current object.\n " nullable: true items: $ref: '#/components/schemas/HealthInformation' HealthStatus: type: integer description: "Defines the health status for a component.\n \n\n0\ \ = Unknown\n1 = Ok\n2 = Warning\n3 = Error" x-enumNames: - Unknown - Ok - Warning - Error enum: - 0 - 1 - 2 - 3 HealthInformation: type: object description: "Defines the health information details.\n " additionalProperties: false properties: component: type: string description: "The name of the component.\n " nullable: true componentType: type: string description: "The type of component.\n " nullable: true details: type: string description: "The optional details of the health check.\n " nullable: true status: description: "The current health of the component.\n " $ref: '#/components/schemas/HealthStatus' IJsonResponseOfListOfString: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: type: string errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfTokenResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/TokenResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TokenResponse: type: object description: "Defines the token response.\n " additionalProperties: false properties: token: type: string description: "The generated token.\n " nullable: true idleTimeoutInMinutes: type: integer description: "The number of minutes the token can be idle before it times\ \ out.\n " format: int32 TokenRequest: type: object description: "Defines the request to gain access to the API.\n " additionalProperties: false properties: applicationName: type: string description: "The optional name of the calling application.\n \ \ " nullable: true GraphQlQuery: type: object description: "Graph ql query object.\n " additionalProperties: false required: - query properties: query: type: string description: "Graph query.\n " minLength: 1 variables: type: string description: "Graph variables.\n " nullable: true cachedResults: type: boolean description: "Allow caching and the support of etags.\n " name: type: string description: "Name for the query\n " nullable: true IJsonResponseOfObject: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' GraphQlQueryv2: type: object description: "Graph ql query object.\n " additionalProperties: false required: - query properties: query: type: string description: "Graph query.\n " minLength: 1 variables: description: "Graph variables.\n " nullable: true cachedResults: type: boolean description: "Allow caching and the support of etags.\n " VerifiedTravelDocument: type: object description: "The model for a dotRez verified travel document.\n " additionalProperties: false required: - documentTypeCode - issuedByCode properties: documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: string description: "The issuer code for the travel document (country code).\n\ \ " maxLength: 3 minLength: 0 isInfant: type: boolean description: "Flag for if this verified travel document is for an infant\ \ or not.\n " UpdateVerifiedTravelDocumentsRequest: type: object description: "The model for a dotRez updated verified travel documents request.\n\ \ " additionalProperties: false required: - recordLocator - segmentKey - passengerKey - verifiedTravelDocuments properties: recordLocator: type: string description: "The record locator of the booking.\n " minLength: 1 segmentKey: type: string description: "The segment key.\n " minLength: 1 passengerKey: type: string description: "The passenger key.\n " minLength: 1 verifiedTravelDocuments: type: array description: "The list of verified travel documents.\n " items: $ref: '#/components/schemas/VerifiedTravelDocument' BlockSeatsRequest: type: object description: "Block seats request.\n " additionalProperties: false required: - unitKeys properties: unitKeys: type: array description: "The unit keys to block seats on.\n " items: type: string blockType: description: "The seat block type.\n " $ref: '#/components/schemas/SeatBlockType' SeatBlockType: type: integer description: "Enumeration representing all the different seat block types.\n\ \ \n\n0 = Blocked\n1 = Broken" x-enumNames: - Blocked - Broken enum: - 0 - 1 IJsonResponseOfInventoryLegv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/InventoryLegv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' InventoryLegv2: type: object description: "Defines the inventory leg v2.\n " additionalProperties: false properties: legKey: type: string description: "The unique leg key.\n " nullable: true legInformation: description: "The leg information.\n " nullable: true $ref: '#/components/schemas/InventoryLegInformation' operatingInformation: description: "The leg's market information.\n " nullable: true $ref: '#/components/schemas/OperatingInformation' identifier: description: "The leg's transportation identifier information.\n \ \ " nullable: true $ref: '#/components/schemas/TransportationIdentifier' designator: description: "The leg's designator information.\n " nullable: true $ref: '#/components/schemas/TransportationDesignator' departureTimeUtc: type: string description: "The leg's departure time in UTC.\n " format: date-time nullable: true arrivalTimeUtc: type: string description: "The leg's arrival time in UTC.\n " format: date-time nullable: true nests: type: array description: "The leg nests.\n " nullable: true items: $ref: '#/components/schemas/InventoryLegNest' legMoveControls: description: "The leg move controls.\n " nullable: true $ref: '#/components/schemas/LegMoveControls' legSsrs: type: array description: "The leg ssrs.\n " nullable: true items: $ref: '#/components/schemas/LegSsr' legCrossReferences: type: array description: "The leg cross references.\n " nullable: true items: $ref: '#/components/schemas/LegCrossReference' InventoryLegInformation: type: object description: "Represents the inventory leg information model.\n " additionalProperties: false properties: lid: type: integer description: "The leg's lid.\n " maximum: 32767.0 minimum: 0.0 nullable: true adjustedCapacity: type: integer description: "The leg's adjusted capacity.\n " maximum: 32767.0 minimum: 0.0 nullable: true legNumber: type: integer description: "The leg number.\n " capacity: type: integer description: "The leg's capacity.\n " equipmentType: type: string description: "The equipment type for the leg.\n " nullable: true equipmentTypeSuffix: type: string description: "The equipment type suffix for the leg.\n " nullable: true equipmentChange: type: boolean description: "Indicates if there is an equipment change\n " managed: type: boolean description: "Indicates if the leg is managed.\n " status: description: "The leg's status.\n " $ref: '#/components/schemas/LegStatus' prbcCode: type: string description: "The passenger reservation booking configuration (PRBC) code.\n\ \ " nullable: true marketingCode: type: string description: "The marketing code.\n " nullable: true codeShareIndicator: description: "The code share indicator.\n " $ref: '#/components/schemas/CodeShareIndicator' LegStatus: type: integer description: "Leg status enumeration.\n \n\n0 = Normal\n1 = Closed\n\ 2 = Canceled\n3 = Suspended\n5 = ClosedPending\n6 = BlockAllActivities\n7\ \ = Mishap" x-enumNames: - Normal - Closed - Canceled - Suspended - ClosedPending - BlockAllActivities - Mishap enum: - 0 - 1 - 2 - 3 - 5 - 6 - 7 CodeShareIndicator: type: integer description: "Specifies the type of code share agreement.\n \n\n\ 0 = NonCodeShare\n1 = CodeShareCommercialDuplicate\n2 = SharedDesignatorOrWetLease\n\ 3 = CodeShareHostOperatingCarrier\n4 = CodeShareCommercialDuplicateWithOverrideText\n\ 5 = SharedDesignatorOrWetLeaseWithOverrideText" x-enumNames: - NonCodeShare - CodeShareCommercialDuplicate - SharedDesignatorOrWetLease - CodeShareHostOperatingCarrier - CodeShareCommercialDuplicateWithOverrideText - SharedDesignatorOrWetLeaseWithOverrideText enum: - 0 - 1 - 2 - 3 - 4 - 5 OperatingInformation: type: object description: "Represents the operating information model.\n " additionalProperties: false properties: comment: type: string description: "The operated by comment field.\n " nullable: true identifier: type: string description: "The unique transportation identifier.\n " maxLength: 4 minLength: 0 nullable: true carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 nullable: true opSuffix: type: string description: "The op suffix.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 nullable: true TransportationIdentifier: type: object description: "Represents the transportation identifier model data.\n \ \ " additionalProperties: false required: - identifier - carrierCode properties: identifier: type: string description: "The unique transportation identifier.\n " maxLength: 4 minLength: 0 carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 opSuffix: type: string description: "The op suffix.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 nullable: true TransportationDesignator: type: object description: "Model information about the traveling arrival and destination\ \ details.\n " additionalProperties: false properties: destination: type: string description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 nullable: true origin: type: string description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 nullable: true arrival: type: string description: "The arrival date and time local to the arrival station.\n\ \ " format: date-time departure: type: string description: "The departure date and time local to the departure station.\n\ \ " format: date-time InventoryLegNest: type: object description: "Represents the inventory leg nest model.\n " additionalProperties: false properties: nestKey: type: string description: "The unique identifier for the nest within a leg.\n \ \ " nullable: true cabinOfService: type: string description: "The cabin of service.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 nullable: true type: description: "The nest type.\n " $ref: '#/components/schemas/NestType' lid: type: integer description: "The nest's lid.\n " maximum: 32767.0 minimum: 0.0 nullable: true adjustedCapacity: type: integer description: "The nest's adjusted capacity.\n " maximum: 32767.0 minimum: 0.0 nullable: true classes: type: array description: "The collection of leg classes within the nest.\n \ \ " nullable: true items: $ref: '#/components/schemas/InventoryLegClass' NestType: type: integer description: "Nest type enumeration.\n \n\n0 = Default\n1 = Net\n\ 2 = Serial\n3 = OneBooking" x-enumNames: - Default - Net - Serial - OneBooking enum: - 0 - 1 - 2 - 3 InventoryLegClass: type: object description: "The inventory leg class model.\n " additionalProperties: false properties: type: description: "The class of service type.\n " nullable: true $ref: '#/components/schemas/ClassOfServiceType' rank: type: integer description: "The class of service rank.\n " maximum: 32767.0 minimum: 1.0 nullable: true authorizedUnits: type: integer description: "The class of service authorized unit count.\n " maximum: 32767.0 minimum: 0.0 nullable: true allotted: type: integer description: "The class of service allotted count.\n " maximum: 32767.0 minimum: 0.0 nullable: true latestAdvancedReservation: type: integer description: "The class of service's latest advanced purchase reservation.\n\ A value of zero indicates that there is no restriction.\n " maximum: 32767.0 minimum: 0.0 nullable: true classKey: type: string description: "The unique identifier for the leg class.\n " nullable: true classOfService: type: string description: "The class of service.\n " nullable: true status: description: "The class status.\n " $ref: '#/components/schemas/ClassStatus' seatsSold: description: "The number of seats sold for the class of service\nof this\ \ leg.\n " nullable: true $ref: '#/components/schemas/SeatsSoldBase' ClassOfServiceType: type: integer description: "The class of service type enumeration.\n \n\n0 = Default\n\ 1 = Normal\n2 = Discrete\n3 = NonNested\n4 = NegoAllotment\n5 = ProrataAllotment\n\ 6 = OperatingBlockspace\n7 = MarketingBlockspace" x-enumNames: - Default - Normal - Discrete - NonNested - NegoAllotment - ProrataAllotment - OperatingBlockspace - MarketingBlockspace enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 ClassStatus: type: integer description: "Indicates whether a leg class may be used or not.\n \ \ \n\n1 = Active\n2 = InActive\n3 = AvsOpen\n4 = AvsOnRequest\n5 = AvsClosed" x-enumNames: - Active - InActive - AvsOpen - AvsOnRequest - AvsClosed enum: - 1 - 2 - 3 - 4 - 5 SeatsSoldBase: type: object description: "Represents the seats sold base model.\n " additionalProperties: false properties: total: type: integer description: "The number of seats sold.\n " throughTotal: type: integer description: "The number of seats sold as part of a through flight.\n \ \ " nonStopTotal: type: integer description: "The number of seats sold as part of a non-stop flight.\n \ \ " connectTotal: type: integer description: "The number of seats sold as part of a connecting flight.\n\ \ " LegMoveControls: type: object description: "The leg move control model information.\n " additionalProperties: false properties: moveOutDays: type: integer description: "The maximum number of days this leg can be moved out.\n \ \ " moveBackDays: type: integer description: "The maximum number of days this leg can be moved back.\n \ \ " flyAhead: description: "The fly-ahead related information.\n " nullable: true $ref: '#/components/schemas/FlyAheadControls' FlyAheadControls: type: object description: "The leg fly-ahead control model information.\n " additionalProperties: false properties: offerStatus: description: "The fly-ahead offer status for the leg.\n " $ref: '#/components/schemas/FlyAheadOfferStatus' isCandidate: type: boolean description: "True if the leg is available for use in fly-ahead candidates;\ \ false otherwise.\n " departBeforeMinutes: type: integer description: "The number of minutes before departure of the current journey\ \ that a\ncandidate journey is allowed to depart if that candidate journey\n\ contains this leg.\n " maximum: 30240.0 minimum: 0.0 departAfterMinutes: type: integer description: "The number of minutes after departure of the current journey\ \ that a\ncandidate journey is allowed to depart if that candidate journey\n\ contains this leg.\n " maximum: 30240.0 minimum: 0.0 arrivalAfterMinutes: type: integer description: "The number of minutes after arrival of the current journey\ \ that a\ncandidate journey is allowed to depart if that candidate journey\n\ contains this leg.\n " maximum: 30240.0 minimum: 0.0 soldThresholdPercent: type: integer description: "The maximum resulting sold threshold percentage for the candidate\n\ journey if this leg is present in that candidate journey. Min = 0,\n\ Max = 255, Default = 100.\n " maximum: 255.0 minimum: 0.0 mustBeSameJourneyType: type: boolean description: "Controls whether the candidate journey must be of the same\ \ journey type.\n " FlyAheadOfferStatus: type: integer description: "The fly ahead offer status enumeration.\n \n\n0 = None\n\ 1 = Involuntary\n2 = Voluntary\n3 = DisabledIfFirstLeg" x-enumNames: - None - Involuntary - Voluntary - DisabledIfFirstLeg enum: - 0 - 1 - 2 - 3 LegSsr: type: object description: "A model representing a leg ssr summary.\n " additionalProperties: false properties: available: type: integer description: "The number of Ssrs available.\n " ssrNestCode: type: string description: "The SSR nest code.\n " maxLength: 4 minLength: 0 nullable: true lid: type: integer description: "The maximum number of SSRs authorized to be sold on a nest.\n\ \ " sold: type: integer description: "The number of SSRs sold in the SSR nest.\n " unitSold: type: integer description: "The units of space sold for the SSR.\n " LegCrossReference: type: object description: "Represents the inventory leg cross reference data.\n \ \ " additionalProperties: false properties: legKey: type: string description: "The key for the manifest leg.\n " nullable: true number: type: integer description: "The inventory leg cross reference number.\n " maximum: 32767.0 minimum: 0.0 marketInformation: description: "Information about the market arrival and destination details.\n\ \ " nullable: true $ref: '#/components/schemas/MarketInformation' MarketInformation: type: object description: "Model information about the market arrival and destination details.\n\ \ " additionalProperties: false required: - destination - origin - departureDate - identifier properties: destination: type: string description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 origin: type: string description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 departureDate: type: string description: "The departure date.\n " format: date-time minLength: 1 identifier: description: "Gets or sets the leg arrival station.\n " $ref: '#/components/schemas/TransportationIdentifier' InventoryLegEditv2Request: type: object description: "Represents the inventory leg edit v2 request.\n " additionalProperties: false properties: lid: type: integer description: "The leg's lid.\n " maximum: 32767.0 minimum: 0.0 nullable: true adjustedCapacity: type: integer description: "The leg's adjusted capacity.\n " maximum: 32767.0 minimum: 0.0 nullable: true sendAvsMessages: type: boolean description: "Specifies if an AVS messages should be sent for changes.\n\ \ " status: description: "The leg status.\n " nullable: true $ref: '#/components/schemas/LegStatusRequestType' nests: type: object description: "The list of nests to update, by leg nest key.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/InventoryLegEditv2NestDetails' LegStatusRequestType: type: integer description: "The leg status request enumeration.\n \n\n0 = Normal\n\ 1 = Suspended\n2 = BlockAllActivities" x-enumNames: - Normal - Suspended - BlockAllActivities enum: - 0 - 1 - 2 InventoryLegEditv2NestDetails: type: object description: "Represents an individual nest in the v2 leg edit request.\n \ \ " additionalProperties: false properties: lid: type: integer description: "The nest's lid.\n " maximum: 32767.0 minimum: 0.0 nullable: true adjustedCapacity: type: integer description: "The nest's adjusted capacity.\n " maximum: 32767.0 minimum: 0.0 nullable: true classes: type: object description: "The list of classes to update, by leg class key.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/ClassEditDetails' ClassEditDetails: type: object description: "Represents the editable details for an inventory\nleg nest class.\n\ \ " additionalProperties: false properties: type: description: "The class of service type.\n " nullable: true $ref: '#/components/schemas/ClassOfServiceType' rank: type: integer description: "The class of service rank.\n " maximum: 32767.0 minimum: 1.0 nullable: true authorizedUnits: type: integer description: "The class of service authorized unit count.\n " maximum: 32767.0 minimum: 0.0 nullable: true allotted: type: integer description: "The class of service allotted count.\n " maximum: 32767.0 minimum: 0.0 nullable: true latestAdvancedReservation: type: integer description: "The class of service's latest advanced purchase reservation.\n\ A value of zero indicates that there is no restriction.\n " maximum: 32767.0 minimum: 0.0 nullable: true IJsonResponseOfBoardPassengerResponsev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BoardPassengerResponsev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BoardPassengerResponsev2: type: object description: "Defines the response from boarding a passenger.\n " additionalProperties: false properties: passengerName: description: "The name of the passenger.\n " nullable: true $ref: '#/components/schemas/Name' recordLocator: type: string description: "The booking record locator.\n " nullable: true securityAuthorizationList: type: array description: "The list of security authorization. Will be populated when\ \ there are negative APP directives during secure\nboarding.\n \ \ " nullable: true items: $ref: '#/components/schemas/SecurityAuthorizationInformation' Name: type: object description: "Defines a common name.\n " additionalProperties: false properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true SecurityAuthorizationInformation: type: object description: "The passenger's government security authorization information\ \ for boarding clearance and access to airport\nrestricted areas.\n \ \ " additionalProperties: false properties: governmentMessageType: description: "The corresponding message type for this authorization.\n \ \ " $ref: '#/components/schemas/GovernmentMessageType' authorizationStatus: type: string description: "The clearance based on the program driver (APIS, APPS, SF/AQQ).\n\ \ " nullable: true securityAuthorizationText: type: array description: "List of government security authorization free text.\n \ \ " nullable: true items: $ref: '#/components/schemas/SecurityAuthorizationText' marketInformation: description: "The market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' forInfant: type: boolean description: "Whether the passenger is an infant or not.\n " programDescription: type: string description: "Indicates the user friendly program description associated\ \ with the government message type.\nThis is added for display purposes\ \ for the UI. So that they will know what to display for the specific\ \ government\nmessage type.\n " nullable: true driverName: type: string description: "Indicates the driver name associated with the government message\ \ type.\nThis is added so that the UI will know, during override, what\ \ driver name to indicate in an override request.\n " nullable: true checkinOverrideAllowed: type: boolean description: "Indicates whether a check-in override is allowed.\n \ \ " outageMode: type: boolean description: "Indicates whether in outage mode or not.\n " validOverrideResponseCodes: type: array description: "List of all government response codes that can be entered\ \ during the override process.\n " nullable: true items: $ref: '#/components/schemas/AuthorizationStatusConfiguration' isDepartureValue: type: boolean description: "Used with APPS to represent if this clearance is associated\ \ with the departure country.\n " checkinAllowed: type: boolean description: "Determines whether this authorization allows the passenger\ \ to check-in.\n " boardingAllowed: type: boolean description: "Determines whether this authorization allows the passenger\ \ to board.\n " authorizationStatusDescription: type: string description: "This will contain the user-friendly description of the authorization\ \ status.\n " nullable: true screeningType: description: "The government screening type.\n " $ref: '#/components/schemas/GovernmentScreeningType' electronicTravelAuthorization: description: "The government generic electronic travel authorization value.\n\ \ " $ref: '#/components/schemas/ElectronicTravelAuthorization' manuallyOverridden: type: boolean description: "Determines whether that passenger's authorization is manually\ \ overridden.\n " autoOutage: type: boolean description: "Indicates if the authorization was automatically overridden\ \ due to outage.\n " clearanceCountry: type: string description: "This authorization status is from this country, if applicable.\ \ 2-character country code.\n " nullable: true errorResponse: type: boolean description: "An error was returned from the government.\n " passedSecurity: type: boolean description: "Represents that a passenger has passed security or is is a\ \ secure area.\n " departureDetail: type: string description: "Departure detail information for APPS security authorization.\n\ \ " nullable: true arrivalDetail: type: string description: "Arrival detail information for APPS security authorization.\n\ \ " nullable: true GovernmentMessageType: type: integer description: "Defines the government message type.\n \n\n0 = None\n\ 1 = Aqq\n2 = SecureFlight\n3 = Apps\n4 = Apis\n5 = Iapp\n6 = Eub\n7 = Iatci\n\ 8 = DocCheck\n9 = DocsOnly\n10 = PnrGov\n11 = Digiyatra\n12 = 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 SecurityAuthorizationText: type: object description: "The passenger's government security authorization free text.\n\ \ " additionalProperties: false properties: code: type: string description: "The code qualifier.\n " nullable: true text: type: string description: "Free text.\n " nullable: true displayText: type: boolean description: "Whether or not to display the free text.\n " AuthorizationStatusConfiguration: type: object description: "The government security authorization status configuration that\ \ corresponds to a government security message type.\nAuthorization status\ \ configuration is the object used when getting the config and the validOverrideResponseCodes.\n\ The object for the passenger is government security authorization.\n \ \ " additionalProperties: false properties: authorizationStatusCode: type: string description: "The boarding directive returned from the government agency.\n\ \ " nullable: true checkInAllowed: type: boolean description: "Indicates whether this authorization allows the passenger\ \ to check-in.\n " boardingPassPrintingAllowed: type: boolean description: "Indicates whether this authorization allows the passenger\ \ to be issued or print a boarding pass.\n " boardingAllowed: type: boolean description: "Indicates whether this authorization allows the passenger\ \ to board.\n " selfCheckInAllowed: type: boolean description: "Indicates whether this authorization allows the passenger\ \ to check-in via the web, kiosk, mobile, etc.\n " authorizationStatusDescription: type: string description: "This will contain the user-friendly description of the Authorization\ \ Status.\nIt will be used during the override process as a list of valid\ \ Authorization Status Code.\n " nullable: true screeningType: description: "The government screening type code.\n " $ref: '#/components/schemas/GovernmentScreeningType' customFreeText: type: string description: "Custom text including error messages the UI can display to\ \ the agent based on the Authorization Status Code.\n " nullable: true electronicTravelAuthorization: description: "Government generic electronic travel authorization values.\ \ This is used by the UI to differentiate which exception\ntype to throw\ \ based on the authorization status code ESTA value.\n " $ref: '#/components/schemas/ElectronicTravelAuthorization' boardingPassPrintText: type: string description: "Holds custom boarding pass text like SSSS for Selectee or\ \ TSA Pre-check.\n " nullable: true promptToVerifyId: type: boolean description: "Indicates whether the UI should prompt to verify the passenger's\ \ Id.\n " errorResponse: type: boolean description: "Indicates whether an error was returned from the government\ \ like 4Z.\n " incompleteDirective: type: boolean description: "Indicates whether part of the authorization status is missing.\n\ For example, \"0?\" is an incomplete secure flight authorization status.\n\ \ " validOverrideAuthorizationCode: type: boolean description: "Indicates whether this code should be included in the override\ \ prompt.\n " validGatePassOverrideAuthorizationCode: type: boolean description: "Indicates whether this code should be included in the override\ \ prompt for gate pass.\n " checkInOverrideAllowed: type: boolean description: "Will be set if in SF/iAPP outage mode or for APPS D, T or\ \ U directives.\n " gatePassAllowed: type: boolean description: "Indicates whether this authorization allows the passenger\ \ to have a gate pass.\n " gatePassOverrideAllowed: type: boolean description: "Indicates whether the gate pass authorization status can be\ \ manually overridden.\n " canResubmitWithoutQualifiedChange: type: boolean description: "Indicates whether it is allowed to resubmit this authorization\ \ without a qualified change during GetClearance for\naction. This does\ \ not indicate whether the authorization should be resubmitted.\n \ \ " checkInOverrideAllowedMode: description: "Sets when a manual override can occur.\n " $ref: '#/components/schemas/CheckinOverrideAllowedMode' GovernmentScreeningType: type: integer description: "Defines the government security screening type.\n \n\ \n0 = Normal\n1 = LowRisk\n2 = Enhanced\n3 = Inhibited" x-enumNames: - Normal - LowRisk - Enhanced - Inhibited enum: - 0 - 1 - 2 - 3 ElectronicTravelAuthorization: type: integer description: "Defines the electronic travel authorization for the government\ \ boarding directive.\nFor US Secure Flight, this is the electronic system\ \ for travel authorization (ESTA) value.\n \n\n0 = Denied\n1 =\ \ NotApplicable\n2 = OnFile\n3 = NotOnFile\n4 = DocumentRequired\n5 = Error\n\ 6 = TimeOut" x-enumNames: - Denied - NotApplicable - OnFile - NotOnFile - DocumentRequired - Error - TimeOut enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 CheckinOverrideAllowedMode: type: integer description: "Defines the check-in override allowed mode.\n \n\n\ 0 = Never\n1 = Outage\n2 = Normal\n3 = Always" x-enumNames: - Never - Outage - Normal - Always enum: - 0 - 1 - 2 - 3 BoardPassengerBaseRequest: type: object description: "Defines the base request to board a passenger.\n " additionalProperties: false properties: skipSecurityChecks: type: boolean description: "Whether to skip security checks or not.\n " overrideEstaRequirement: type: boolean description: "Identifies if the Electronic System for Travel Authorization\ \ (ESTA) requirement is being overriden.\n " IJsonResponseOfIListOfBoardAllPassengerResponsev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BoardAllPassengerResponsev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BoardAllPassengerResponsev2: type: object description: "Defines the response from boarding all passengers.\n \ \ " additionalProperties: false properties: securityAuthorizationList: type: array description: "The list of security authorization. Will be populated when\ \ there are negative APP directives during secure\nboarding.\n \ \ " nullable: true items: $ref: '#/components/schemas/SecurityAuthorizationInformation' passengerName: description: "The name of the passenger.\n " nullable: true $ref: '#/components/schemas/Name' recordLocator: type: string description: "The booking record locator.\n " nullable: true boarded: type: boolean description: "Whether the passenger was boarded or not.\n " IJsonResponseOfPassengerWeightBalanceSummary: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerWeightBalanceSummary' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerWeightBalanceSummary: type: object description: "The passenger weight balance summary model.\n " additionalProperties: false properties: travelSummary: description: "The travel summary.\n " nullable: true $ref: '#/components/schemas/TravelSummary' totalManifestCounts: description: "The manifest count totals.\n " nullable: true $ref: '#/components/schemas/ManifestCounts' thruManifestedCount: type: integer description: "The thru manifested count.\n " format: int32 baggageSummary: description: "The baggage summary.\n " nullable: true $ref: '#/components/schemas/BaggageSummary' travelClasses: type: array description: "The manifest count totals based on travel class.\n \ \ " nullable: true items: $ref: '#/components/schemas/ManifestTravelClass' zones: type: array description: "The manifest count totals based on zone.\n " nullable: true items: $ref: '#/components/schemas/ManifestZone' bookedSegments: type: array description: "The manifest count totals based on segment.\n " nullable: true items: $ref: '#/components/schemas/ManifestBookedSegment' TravelSummary: type: object description: "Represents the travel summary information.\n " additionalProperties: false properties: status: description: "Status of the flight summary.\n " $ref: '#/components/schemas/LegStatus' number: type: string description: "Number of the flight.\n " nullable: true scheduledDepartureTime: type: string description: "Scheduled departure time.\n " format: date-time scheduledArrivalTime: type: string description: "Scheduled arrival time.\n " format: date-time estimatedDepartureTime: type: string description: "Estimated departure time.\n " format: date-time estimatedArrivalTime: type: string description: "Estimated arrival time.\n " format: date-time actualDepartureTime: type: string description: "Actual departure time.\n " format: date-time actualArrivalTime: type: string description: "Actual arrival time.\n " format: date-time departureLtv: type: integer description: "Departure LTV time offset in minutes. To convert from Local\ \ time to UTC time you would\nneed to subtract this value for the current\ \ local time.\n " arrivalLtv: type: integer description: "Arrival LTV time offset in minutes. To convert from Local\ \ time to UTC time you would\nneed to subtract this value for the current\ \ local time.\n " equipmentType: type: string description: "Equipment type.\n " nullable: true equipmentTypeSuffix: type: string description: "Equipment type suffix.\n " nullable: true marketingConfigurationCode: type: string description: "Marketing configuration code.\n " nullable: true salesConfigurationCode: type: string description: "Sales configuration code.\n " nullable: true market: description: "InventoryLegKey about the flight.\n " nullable: true $ref: '#/components/schemas/MarketInformation' ManifestCounts: type: object description: "The manifest counts base model.\n " additionalProperties: false properties: totalManifested: type: integer description: "The total manifested count.\n " format: int32 totalCheckIn: type: integer description: "The total check-in count.\n " format: int32 totalNoShow: type: integer description: "The total no show count.\n " format: int32 totalStandby: type: integer description: "The total standby count.\n " format: int32 totalBoarded: type: integer description: "The total boarded count.\n " format: int32 BaggageSummary: type: object description: "The Baggage summary model.\n " additionalProperties: false properties: bagCount: type: integer description: "The total bag counts.\n " format: int32 bagWeight: type: integer description: "The total bag weights.\n " format: int32 weightType: description: "The weight unit type.\n " $ref: '#/components/schemas/WeightType' baggageDetails: type: array description: "The collection of baggage details.\n " nullable: true items: $ref: '#/components/schemas/BaggageDetails' WeightType: type: integer description: "Weight Type enumeration.\n \n\n0 = Default\n1 = Pounds\n\ 2 = Kilograms" x-enumNames: - Default - Pounds - Kilograms enum: - 0 - 1 - 2 BaggageDetails: type: object description: "Defines the baggage model.\n " additionalProperties: false properties: bagCount: type: integer description: "The total bag counts.\n " format: int32 bagWeight: type: integer description: "The total bag weights.\n " format: int32 weightType: description: "The weight unit type.\n " $ref: '#/components/schemas/WeightType' baggageCode: type: string description: "The baggage code.\n " nullable: true ManifestTravelClass: type: object description: "The manifest travel class model.\n " additionalProperties: false properties: code: type: string description: "The travel class code.\nPlease note that this should be a\ \ char and not a string.\n " maxLength: 1 baggageSummary: description: "The baggage summary.\n " nullable: true $ref: '#/components/schemas/BaggageSummary' passengersSummaries: type: array description: "The passengers summary.\n " nullable: true items: $ref: '#/components/schemas/PassengersSummary' PassengersSummary: type: object description: "The passenger count summary model.\n " additionalProperties: false properties: status: description: "The passenger status.\n " $ref: '#/components/schemas/LiftStatus' totalMaleCount: type: integer description: "The total male count.\n " format: int32 totalFemaleCount: type: integer description: "The total female count.\n " format: int32 totalChildCount: type: integer description: "The total child count.\n " format: int32 totalInfantCount: type: integer description: "The total infant count.\n " format: int32 LiftStatus: type: integer description: "Lift status enumeration.\n \n\n0 = Default\n1 = CheckedIn\n\ 2 = Boarded\n3 = NoShow" x-enumNames: - Default - CheckedIn - Boarded - NoShow enum: - 0 - 1 - 2 - 3 ManifestZone: type: object description: "The manifest zone model.\n " additionalProperties: false properties: code: type: integer description: "The zone code.\n " capacity: type: integer description: "The zone capacity.\n " baggageSummary: description: "The zone baggage summary.\n " nullable: true $ref: '#/components/schemas/BaggageSummary' passengersSummaries: type: array description: "The zone passengers summary.\n " nullable: true items: $ref: '#/components/schemas/PassengersSummary' ManifestBookedSegment: type: object description: "The manifest booked segment model.\n " additionalProperties: false properties: counts: description: "The manifest counts base.\n " nullable: true $ref: '#/components/schemas/ManifestCounts' baggageDetails: description: "The baggage details.\n " nullable: true $ref: '#/components/schemas/BaggageDetailsBase' marketInformation: description: "The market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' travelClasses: type: array description: "The travel class.\n " nullable: true items: $ref: '#/components/schemas/ManifestTravelClass' nonConnectingPassengers: description: "Passengers with no connections.\n " nullable: true $ref: '#/components/schemas/NonConnectingPassengers' connectingPassengers: type: array description: "Passengers who have connecting segments.\n " nullable: true items: $ref: '#/components/schemas/ConnectingPassengers' BaggageDetailsBase: type: object description: "The unit baggage base model.\n " additionalProperties: false properties: bagCount: type: integer description: "The total bag counts.\n " format: int32 bagWeight: type: integer description: "The total bag weights.\n " format: int32 weightType: description: "The weight unit type.\n " $ref: '#/components/schemas/WeightType' NonConnectingPassengers: type: object description: "The model for passengers with no connections.\n " additionalProperties: false properties: counts: description: "No connection total counts.\n " nullable: true $ref: '#/components/schemas/ManifestCounts' baggageDetails: description: "No connection baggage unit counts.\n " nullable: true $ref: '#/components/schemas/BaggageDetailsBase' ConnectingPassengers: type: object description: "Model representing passengers booked on a specified connecting\ \ segment.\n " additionalProperties: false properties: counts: description: "No connection total counts.\n " nullable: true $ref: '#/components/schemas/ManifestCounts' baggageDetails: description: "No connection baggage unit counts.\n " nullable: true $ref: '#/components/schemas/BaggageDetailsBase' segmentInformation: description: "Market information for a specified segment.\n " nullable: true $ref: '#/components/schemas/MarketInformation' travelClasses: type: array description: "Segment travel classes.\n " nullable: true items: $ref: '#/components/schemas/ManifestTravelClass' IJsonResponseOfInventoryLegClass: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/InventoryLegClass' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' DeltaMapperOfInventoryClassEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: type: description: "The class of service type.\n " nullable: true $ref: '#/components/schemas/ClassOfServiceType' rank: type: integer description: "The class of service rank.\n " maximum: 32767.0 minimum: 1.0 nullable: true authorizedUnits: type: integer description: "The class of service authorized unit count.\n " maximum: 32767.0 minimum: 0.0 nullable: true allotted: type: integer description: "The class of service allotted count.\n " maximum: 32767.0 minimum: 0.0 nullable: true latestAdvancedReservation: type: integer description: "The class of service's latest advanced purchase reservation.\n\ A value of zero indicates that there is no restriction.\n " maximum: 32767.0 minimum: 0.0 nullable: true sendAvsMessages: type: boolean description: "Specifies if an AVS messages should be sent for changes.\n\ \ " DeltaMapperPatch: type: object description: "Delta mapper patch updates a specific property of an object using\ \ non dynamic information useful in languages like\nGraph Ql.\n \ \ " additionalProperties: false properties: stringValue: type: string description: "Value in string form.\n " nullable: true numericValue: type: number description: "Value in string form.\n " format: decimal nullable: true path: type: string description: "The property route ex name or name\\first.\n " nullable: true jsonValue: type: string description: "The string representation of the objects value.\n \ \ " nullable: true InventoryClassEditRequest: type: object description: "Represents the edit request for an individual inventory\nleg nest\ \ class.\n " additionalProperties: false properties: type: description: "The class of service type.\n " nullable: true $ref: '#/components/schemas/ClassOfServiceType' rank: type: integer description: "The class of service rank.\n " maximum: 32767.0 minimum: 1.0 nullable: true authorizedUnits: type: integer description: "The class of service authorized unit count.\n " maximum: 32767.0 minimum: 0.0 nullable: true allotted: type: integer description: "The class of service allotted count.\n " maximum: 32767.0 minimum: 0.0 nullable: true latestAdvancedReservation: type: integer description: "The class of service's latest advanced purchase reservation.\n\ A value of zero indicates that there is no restriction.\n " maximum: 32767.0 minimum: 0.0 nullable: true sendAvsMessages: type: boolean description: "Specifies if an AVS messages should be sent for changes.\n\ \ " IJsonResponseOfInventoryLegNest: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/InventoryLegNest' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' DeltaMapperOfInventoryNestEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: lid: type: integer description: "The nest's lid.\n " maximum: 32767.0 minimum: 0.0 nullable: true adjustedCapacity: type: integer description: "The nest's adjusted capacity.\n " maximum: 32767.0 minimum: 0.0 nullable: true sendAvsMessages: type: boolean description: "Specifies if an AVS messages should be sent for changes.\n\ \ " InventoryNestEditRequest: type: object description: "Represents the edit request for an individual inventory leg nest.\n\ \ " additionalProperties: false properties: lid: type: integer description: "The nest's lid.\n " maximum: 32767.0 minimum: 0.0 nullable: true adjustedCapacity: type: integer description: "The nest's adjusted capacity.\n " maximum: 32767.0 minimum: 0.0 nullable: true sendAvsMessages: type: boolean description: "Specifies if an AVS messages should be sent for changes.\n\ \ " IJsonResponseOfDictionaryOfStringAndListOfInventoryLegSSRLid: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/InventoryLegSSRLid' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' InventoryLegSSRLid: type: object description: "Represents an SSR lid update request.\n " additionalProperties: false required: - ssrNestCode - lid properties: ssrNestCode: type: string description: "The code of the SSR nest. For the configured details of this\ \ code, please use GET\n`api/nsk/v1/resources/SsrNests/{ssrNestCode}`.\n\ \ " maxLength: 4 minLength: 1 lid: type: integer description: "The maximum number of SSRs authorized to be sold on a nest.\n\ \ " InventoryLegSSRLidsPatchRequest: type: object description: "Represents the inventory leg and its ssr lids.\n " additionalProperties: false required: - legKey - ssrLids properties: legKey: type: string description: "The unique leg key.\n " maxLength: 10000 minLength: 0 ssrLids: type: array description: "The collection of ssr lids.\n " items: $ref: '#/components/schemas/InventoryLegSSRLid' IJsonResponseOfIListOfInventoryRouteClass: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/InventoryRouteClass' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' InventoryRouteClass: type: object description: "Represents classes at the route level.\n " additionalProperties: false properties: authorizedUnits: type: integer description: "The class of service authorized unit count.\n " maximum: 32767.0 minimum: 0.0 nullable: true classOfService: type: string description: "The class of service for the journey.\n " maxLength: 8 minLength: 0 nullable: true manageAuthorizedUnits: type: boolean description: "Indicator for if the AU can be managed at\nthe journey level.\n\ \ " InventoryRouteClassEditRequest: type: object description: "Represents the edit request for an individual inventory\nroute\ \ class.\n " additionalProperties: false properties: authorizedUnits: type: integer description: "The class of service authorized unit count.\n " maximum: 32767.0 minimum: 0.0 nullable: true IJsonResponseOfIListOfEquipmentSwapPassenger: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/EquipmentSwapPassenger' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' EquipmentSwapPassenger: type: object description: "Defines the moved passenger as a result of swapping equipment.\n\ \ " additionalProperties: false properties: passengerAlternateKey: type: string description: "The passenger alternate key because NewSkies gives us back\ \ the PassengerId\n " nullable: true passengerName: description: "The name of the passenger that was swapped.\n " nullable: true $ref: '#/components/schemas/Name' recordLocator: type: string description: "The record locator for the passenger.\n " nullable: true oldSeat: description: "The seat on the old equipment.\n " nullable: true $ref: '#/components/schemas/EquipmentSwapSeat' newSeat: description: "The seat on the new equipment.\n " nullable: true $ref: '#/components/schemas/EquipmentSwapSeat' identifier: description: "The flight on which the passenger lost a seat assignment.\n\ \ " nullable: true $ref: '#/components/schemas/TransportationIdentifier' departureStation: type: string description: "Airport code where the lost seat assignment begins.\n \ \ " nullable: true arrivalStation: type: string description: "Airport code where the lost seat assignment ends.\n \ \ " nullable: true liftStatus: description: "The lift status of the passenger who has a lost seat assignment.\n\ \ " $ref: '#/components/schemas/LiftStatus' EquipmentSwapSeat: type: object description: "Defines the moved seat as a result of swapping equipment.\n \ \ " additionalProperties: false properties: row: type: integer description: "The row of the aircraft the seat is in.\n " column: type: string description: "The column of the aircraft the seat is in.\nPlease note that\ \ this should be a char and not a string.\n " maxLength: 1 cabinOfService: type: string description: "The cabin of services the seat is in.\nPlease note that this\ \ should be a char and not a string.\n " maxLength: 1 EquipmentSwapRequest: type: object description: "Defines the equipment swap request.\n " additionalProperties: false properties: marketInformation: description: "The market information for the flight to swap equipment.\n\ \ " nullable: true $ref: '#/components/schemas/MarketInformation' equipmentType: type: string description: "The equipment type to switch to.\n " maxLength: 3 minLength: 0 nullable: true equipmentTypeSuffix: type: string description: "The equipment type suffix to switch to.\n " maxLength: 3 minLength: 0 nullable: true prbcCode: type: string description: "The passenger reservation booking configuration (PRBC) code\ \ to switch to.\n " maxLength: 8 minLength: 0 nullable: true marketingCode: type: string description: "The marketing code to switch to.\n " maxLength: 8 minLength: 0 nullable: true updateOperatingInformation: type: boolean description: "Indicates whether to update operating information.\n \ \ " codeShareIndicator: description: "The code share indicator to switch to.\n " $ref: '#/components/schemas/CodeShareIndicator' operatingCarrierCode: type: string description: "The operating carrier code to switch to.\n " maxLength: 3 minLength: 0 nullable: true operatedByText: type: string description: "The operated by text to switch to.\n " maxLength: 64 minLength: 0 nullable: true preserveAus: type: boolean description: "Whether to preserve available units (au's) or not.\n \ \ " preserveInventoryLid: type: boolean description: "Whether to preserve the inventory lid or not.\n \ \ " IJsonResponseOfAssignTailNumbersResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AssignTailNumbersResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AssignTailNumbersResponse: type: object description: "Defines the response from assigning a tail number(s).\n \ \ " additionalProperties: false properties: needEquipmentSwap: type: boolean description: "Whether an equipment swap needs to be performed or not.\n\ \ " equipmentType: type: string description: "The equipment type to swap the leg to.\n " maxLength: 3 minLength: 0 nullable: true equipmentTypeSuffix: type: string description: "The equipment type suffix to swap the leg to.\n \ \ " maxLength: 3 minLength: 0 nullable: true AssignTailNumberRequest: type: object description: "Defines the request to assign a tail number for a leg.\n \ \ " additionalProperties: false required: - legKey - tailNumber properties: legKey: type: string description: "The leg key to assign a tail number to.\n " minLength: 1 tailNumber: type: string description: "The tail number.\n " maxLength: 10 minLength: 0 ignoreEquipmentDifference: type: boolean description: "This flag is set to true to ignore the Aircraft Configuration\ \ difference\nbetween the one set to FlightNumber and the one set to TailNumber.\n\ Under normal circumstances, a user will be prompted to record the tail\ \ number\nassignment as an equipment swap.\n " nullable: true IJsonResponseOfEquipmentConfigurationDetails: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/EquipmentConfigurationDetails' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' EquipmentConfigurationDetails: type: object description: "Defines the full/deep equipment or aircraft that is used for flight\ \ operations.\n " additionalProperties: false properties: type: type: string description: "The type of the equipment.\n " nullable: true typeSuffix: type: string description: "The suffix associated with the equipment type.\n \ \ " nullable: true name: type: string description: "The name of the equipment.\n " nullable: true active: type: boolean description: "Indicates if the equipment is active or inactive.\n \ \ " compartments: type: array description: "The compartments associated with the equipment.\n \ \ " nullable: true items: $ref: '#/components/schemas/Compartment' Compartment: type: object description: "Defines the compartment that is used for flight operations.\n\ \ " additionalProperties: false properties: type: type: string description: "The compartment's type.\n " nullable: true equipmentCategory: description: "The equipment category for the compartment.\n " $ref: '#/components/schemas/EquipmentCategory' name: type: string description: "The name of the compartment.\n " maxLength: 64 minLength: 0 nullable: true deck: type: integer description: "The deck number of the compartment.\n " length: type: integer description: "The length of the compartment.\n " format: int32 width: type: integer description: "The width of the compartment.\n " format: int32 capacity: type: integer description: "The capacity of the compartment.\n " format: int32 sequence: type: integer description: "The sequence of the compartment.\n " format: int32 orientation: type: integer description: "The orientation of the compartment.\n " format: int32 active: type: boolean description: "The flag to indicate if the compartment is active.\n \ \ " designator: type: string description: "The designator of the compartment.\n " nullable: true units: type: array description: "The collection of units within the compartment.\n \ \ " nullable: true items: $ref: '#/components/schemas/Unit' properties: type: array description: "The collection of properties that relate to the compartment.\n\ \ " nullable: true items: $ref: '#/components/schemas/PropertyValue' inUse: type: boolean description: "The flag to indicate if the compartment is in use.\n \ \ " EquipmentCategory: type: integer description: "Represents the category of the equipment used for reservation\ \ operations.\n \n\n0 = None\n1 = JetAircraft\n2 = PistonAircraft\n\ 3 = TurbopropAircraft\n4 = Helicopter\n5 = Surface\n6 = Train\n7 = Bus\n8\ \ = AllCategories" x-enumNames: - None - JetAircraft - PistonAircraft - TurbopropAircraft - Helicopter - Surface - Train - Bus - AllCategories enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 Unit: type: object description: "Defines the compartment's unit that is used for flight operations.\n\ \ " additionalProperties: false properties: designator: type: string description: "Defines unique designator for the unit within the compartment.\n\ \ " maxLength: 6 minLength: 0 nullable: true x: type: integer description: "The horizontal position of the unit in the grid.\n \ \ " y: type: integer description: "This vertical position of the unit in the grid.\n \ \ " type: description: "The type of the unit.\n " $ref: '#/components/schemas/UnitType' assignable: type: boolean description: "Flag indicating if the unit is assignable (aka is a seat).\ \ If false this means that the unit is a fixture.\n " set: type: integer description: "The designator of the group the unit belongs to.\n \ \ " format: int32 properties: type: array description: "The unit's properties.\n " nullable: true items: $ref: '#/components/schemas/PropertyValue' angle: type: integer description: "This angle of the unit in the grid.\n " UnitType: type: integer description: "Defines the type of unit.\n \n\n0 = None\n1 = NormalSeat\n\ 2 = LargeSeat\n3 = Couchette\n4 = Compartment\n5 = Table\n6 = Wall\n7 = Window\n\ 8 = Door\n9 = Stairs\n10 = Wing\n12 = Other\n13 = Bulkhead\n14 = BedOneOfThree\n\ 15 = BedTwoOfThree\n16 = BedThreeOfThree\n17 = BedOneOfTwo\n18 = BedTwoOfTwo\n\ 19 = Bed\n20 = Exit\n21 = LabelRuler\n22 = GenericUnitResizableArea\n23 =\ \ Lavatory\n24 = LavatoryWithHandicappedFacilities\n25 = Luggage\n26 = MovableCompartmentDivider\n\ 27 = Bar\n28 = Closet\n29 = Galley\n30 = MovieScreen\n31 = Storage" x-enumNames: - None - NormalSeat - LargeSeat - Couchette - Compartment - Table - Wall - Window - Door - Stairs - Wing - Other - Bulkhead - BedOneOfThree - BedTwoOfThree - BedThreeOfThree - BedOneOfTwo - BedTwoOfTwo - Bed - Exit - LabelRuler - GenericUnitResizableArea - Lavatory - LavatoryWithHandicappedFacilities - Luggage - MovableCompartmentDivider - Bar - Closet - Galley - MovieScreen - Storage enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 PropertyValue: type: object description: "Defines the equipment configuration property values that are used\ \ for flight operations.\n " additionalProperties: false properties: typeCode: type: string description: "The property type code.\n " maxLength: 8 minLength: 0 nullable: true code: type: string description: "The property code.\n " maxLength: 8 minLength: 0 nullable: true deleted: type: boolean description: "The flag to indicate if the property value was deleted.\n\ \ " propertyValueKey: type: string description: "The unique identifier for the property value.\n \ \ " nullable: true IJsonResponseOfPassengerDocumentCheckResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerDocumentCheckResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerDocumentCheckResponse: type: object description: "Model for passenger document check response.\n " additionalProperties: false properties: passengerAlternateKey: type: string description: "The passenger alternative key.\n " nullable: true name: description: "The passenger name.\n " nullable: true $ref: '#/components/schemas/Name' documentCheckStatus: description: "The document check status of the passenger.\n " $ref: '#/components/schemas/DocumentCheckStatus' DocumentCheckStatus: type: integer description: "Represents the status of a document after performing a third party\ \ document check.\nMore detailed information is intentionally not provided\ \ for security reasons.\n \n\n0 = None\n1 = Ok\n2 = Conditional\n\ 3 = NotOk" x-enumNames: - None - Ok - Conditional - NotOk enum: - 0 - 1 - 2 - 3 PassengerBagEditRequest: type: object description: "A model for a request to update the passenger bags.\n \ \ " additionalProperties: false required: - baggageCount - passengerKey - baggageKey - recordLocator properties: allowBaggageOnNonHosted: type: boolean description: "The flag to indicate if the baggage request is allowed to\ \ process baggage for non-hosted flights.\n " weight: type: integer description: "The baggage weight.\n " maximum: 32767.0 minimum: 0.0 nullable: true processAsIatci: type: boolean description: "The flag to indicate if the request should process as an IATCI\ \ scenario.\n " baggageCount: type: integer description: "The number of bags to process for the update.\n \ \ " format: int32 baggageTypeCode: type: string description: "The baggage type code for the update request.\nThis can only\ \ be updated if the baggage weight is changed at the same time, and if\n\ the baggage type code is active.\n " nullable: true segmentKey: type: string description: "The segment key to update. If the journey key is set, the\ \ request will process all\nsegments associated with the journey, and\ \ will ignore this value.\n " nullable: true journeyKey: type: string description: "The journey key to update. If the journey key is set, the\ \ request will process all\nsegments associated with the journey, and\ \ will ignore the segment key value.\n " nullable: true passengerKey: type: string description: "The passenger key to update.\n " minLength: 1 baggageKey: type: string description: "The baggage key to update.\n " minLength: 1 recordLocator: type: string description: "The record locator for the booking to update.\n \ \ " minLength: 1 AddBaggageRequest: type: object description: "The add baggage request.\n " additionalProperties: false required: - recordLocator - journeyKey - passengerKey properties: recordLocator: type: string description: "The record locator.\n " minLength: 1 journeyKey: type: string description: "The journey key.\n " minLength: 1 passengerKey: type: string description: "The passenger key.\n " minLength: 1 iataIdentifier: type: string description: "The IATA identifier for this request.\n " nullable: true nonStandard: type: boolean description: "Flag for marking a bag as a non-standard piece of luggage.\n\ \ " allowBaggageOnNonHosted: type: boolean description: "The flag to indicate if the baggage request is allowed to\ \ process baggage for non-hosted flights.\n " baggageInformation: description: "The baggage information/details.\n " nullable: true $ref: '#/components/schemas/BaggageInformationRequest' BaggageInformationRequest: type: object description: "The baggage information request.\n " additionalProperties: false properties: type: type: string description: "The baggage type.\n " nullable: true manualBagTag: type: boolean description: "A flag to indicate if the bag tag is manual.\nIf false, the\ \ bag tag should be auto generated.\nTrue = 'SLC123456'\nFalse = '0228123456'\n\ \ " osTag: type: string description: "The baggage tag identifier.\nAutomatic Baggage:\nIATA Standard\ \ digits =\n1st position : 0 = Interline tag\n2nd to 4th position\ \ : The three-digit numeric baggage tag issuer code assigned by\nIATA\ \ to the carrier or non-airline company.\n5th to 10th positions: The six\ \ digit serial number.\nManual Baggage:\n1st to 3rd position : The 3\ \ character station code.\n4th to 9th position : The six digit serial\ \ number.\nExample:'SLC123456' (Manual Bag Tag) or '0228123456' (Automatic\ \ Bag Tag)\n " nullable: true weight: type: integer description: "The baggage weight.\n " maximum: 32767.0 minimum: 0.0 nullable: true weightType: description: "The weight type for the bag. (Pounds or Kilograms)\n \ \ " $ref: '#/components/schemas/WeightType' RemoveBaggageRequest: type: object description: "The delete baggage request.\n " additionalProperties: false required: - recordLocator - journeyKey - passengerKey - baggageKey properties: recordLocator: type: string description: "The record locator.\n " minLength: 1 journeyKey: type: string description: "The journey key.\n " minLength: 1 passengerKey: type: string description: "The passenger key.\n " minLength: 1 baggageKey: type: string description: "The baggage key.\n " minLength: 1 RemoveBaggageByLegKeyRequest: type: object description: "The delete baggage by leg key request.\n " additionalProperties: false required: - recordLocator - legKey - passengerKey - baggageKey properties: recordLocator: type: string description: "The record locator.\n " minLength: 1 legKey: type: string description: "The Leg key or manifest leg key.\n " minLength: 1 passengerKey: type: string description: "The passenger key.\n " minLength: 1 baggageKey: type: string description: "The baggage key.\n " minLength: 1 IJsonResponseOfIListOfBagTagPrinter: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BagTagPrinter' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BagTagPrinter: type: object description: "The bag tag printer model.\n " additionalProperties: false properties: name: type: string description: "The bag tag printer name.\n " nullable: true location: type: string description: "The bag tag printer location.\n " nullable: true address: type: string description: "The bag tag printer address.\n " nullable: true port: type: string description: "The bag tag printer port.\n " nullable: true description: type: string description: "The bag tag printer description.\n " nullable: true IJsonResponseOfCheckinRequirementsv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CheckinRequirementsv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CheckinRequirementsv2: type: object description: "Defines the pre checkin requirements.\n " additionalProperties: false properties: passengers: type: object description: "The collection of passengers and there requirements to checkin.\n\ Key is the PassengerKey.\n " nullable: true additionalProperties: $ref: '#/components/schemas/CheckinPassengerRequirementsv2' governmentProgramRequirements: type: object description: "The collection of government programs requirements.\nKey is\ \ the Government Driver Instance Name, e.g. 'USDHS', 'CBSA', 'KRKIS',\ \ 'APPS', etc.\n " nullable: true additionalProperties: $ref: '#/components/schemas/GovernmentProgramRequirements' restrictions: type: array description: "The list of any non passenger related checkin restrictions\ \ that will restrict the desired segments to be checked\nin.\nThe checkin\ \ restriction type = ('Closed', 'NotOpened', 'PnrLocked', 'MarketingCodeShareNotAllowed',\n\ 'NotPaidInFull', 'PaymentsPending',\n'PaymentsPendingCustomerAction',\ \ 'RestrictedOnAnotherSystem', 'NotAllowed', 'ApisNotAllowed', 'AppsNotAllowed',\n\ 'SegmentNotFound', 'InvalidPrice').\n " nullable: true items: $ref: '#/components/schemas/CheckinRestrictionType' isValid: type: boolean description: "Flag indicating if the ability to checkin is valid.\n \ \ " CheckinPassengerRequirementsv2: type: object description: "Defines an individual passengers checkin requirements.\n \ \ " additionalProperties: false properties: passengerKey: type: string description: "The associated passenger key.\n " nullable: true documentRequirements: description: "The passengers document requirements.\n " nullable: true $ref: '#/components/schemas/CheckinDocumentRequirementsv2' addressRequirements: description: "The passengers address requirements.\n " nullable: true $ref: '#/components/schemas/CheckinAddressRequirements' invalidSsrs: type: array description: "The collection of checkin restricted/invalid SSR's the passenger\ \ contains.\n " nullable: true items: type: string requiredSsrs: type: array description: "The collection of checkin required SSR's the passenger is\ \ missing for each segment.\n " nullable: true items: $ref: '#/components/schemas/CheckinMissingSegmentRequiredSsr' restrictions: type: array description: "The list of passengers restrictions that will restrict passenger\ \ from checkin.\n " nullable: true items: $ref: '#/components/schemas/CheckinPassengerRestriction' isValid: type: boolean description: "Flag indicating if the specific passenger checkin is valid.\n\ \ " CheckinDocumentRequirementsv2: type: object description: "Defines passenger checkin document requirements version 2.\n \ \ " additionalProperties: false properties: documentsOnFile: type: array description: "The collection of document type codes that already exist on\ \ the passenger.\n " nullable: true items: type: string governmentDocumentInstances: type: array description: "The collection of unhandled documents at each acting government\ \ entity.\n " nullable: true items: $ref: '#/components/schemas/GovernmentPassengerDocumentRequirementv2' isValid: type: boolean description: "Flag indicating if the checkin document requirements are all\ \ met and ready/valid for checkin.\n " GovernmentPassengerDocumentRequirementv2: type: object description: "Defines a specific government document requirements for a specific\ \ passenger. Version 2\n " additionalProperties: false properties: governmentInstance: type: string description: "Identifies which instance of government security is associated\ \ with these specific requirements.\n " nullable: true numberOfMissingDocuments: type: integer description: "The number of documents still missing.\n " eligibleDocuments: type: array description: "The collection of eligible documents that have not already\ \ been added by the passenger.\n " nullable: true items: $ref: '#/components/schemas/GovernmentDocumentRequirement' verifiableDocuments: type: array description: "The collection of verifiable documents at each acting government\ \ entity.\n " nullable: true items: $ref: '#/components/schemas/GovernmentDocumentRequirement' documentVerificationRequired: type: boolean description: "Boolean to confirm documents need to be verified.\n***Note***\n\ If it is TRUE, document verification is required.\nIf it is FALSE, it\ \ could be\n1) No document verification is required, or\n2) The given\ \ Travel Documents Type and Count matches the government program driver\ \ requirements, BUT this\ndoes not ensure that all government security\ \ document requirements have been met.\n " GovernmentDocumentRequirement: type: object description: "Defines a certain document requirement regarding a specific government\ \ instance.\n " additionalProperties: false properties: group: description: "The document group.\n " $ref: '#/components/schemas/DocumentGroup' documentTypeCode: type: string description: "The documents type code.\n " nullable: true DocumentGroup: type: integer description: "The document grouping enumeration.\n \n\n0 = Unknown\n\ 1 = AlienRegistrationCard\n2 = PermanentResidentCard\n3 = FacilitationDocument\n\ 4 = InsPass\n5 = MilitaryId\n6 = Passport\n7 = ReEntryPermit\n8 = CreditCard\n\ 9 = TravelVisa\n10 = OaFrequentFlyer\n11 = ParoleLetter\n12 = NoticeOfAction\n\ 13 = TransportationLetter\n14 = BorderCrossingCard\n15 = PilotLicense\n16\ \ = UsNaturalizationCertificate\n17 = RefugeeTravelDocument\n18 = GovernmentId\n\ 19 = DriversLicense\n20 = RedressNumber\n21 = KnownTravelerId\n22 = FormOfId\n\ 23 = Nexus\n24 = 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 CheckinAddressRequirements: type: object description: "Defines a passenger checkin address requirements.\n \ \ " additionalProperties: false properties: isValid: type: boolean description: "Flag indicating if the checkin address requirements are meet\ \ and ready/valid for checkin.\n " addressesOnFile: type: array description: "The collection of addresses that are tagged to a station code\ \ that already exist on the passenger.\n " nullable: true items: type: string unhandledAddresses: type: array description: "The collection of unhandled tagged to station addresses required.\n\ \ " nullable: true items: type: string CheckinMissingSegmentRequiredSsr: type: object description: "Defines the a segments collection of missing SSR's.\n \ \ " additionalProperties: false properties: codes: type: array description: "The collection of SSR's missing.\n " nullable: true items: type: string designator: description: "The transportation designator that the SSR codes are missing\ \ from.\n " nullable: true $ref: '#/components/schemas/TransportationDesignator' CheckinPassengerRestriction: type: object description: "Defines a passengers restriction for the current segment trying\ \ to be checked into.\n " additionalProperties: false properties: restriction: description: "The passenger restriction type.\n " $ref: '#/components/schemas/CheckinPassengerRestrictionType' description: type: string description: "The description of the restriction.\n " nullable: true CheckinPassengerRestrictionType: type: integer description: "Defines the checkin passenger restriction types.\n \ \ \n\n0 = NotFound\n1 = MissingDestinationAddress\n2 = MissingCountryOrResidence\n\ 3 = OnLockQueue\n4 = MissingRequiredSsrs\n5 = ContainsRestrictedSsrs\n6 =\ \ IsSelectee\n7 = MissingSeat\n8 = NotConfirmed\n9 = NotStandby\n10 = ContainsUnknownSsr\n\ 11 = MissingApisRequirement\n12 = MissingDocuments\n13 = MissingName\n14 =\ \ MissingInfantName\n15 = MissingDateOfBirth\n16 = MissingInfantDateOfBirth\n\ 17 = RestrictedInfantInLap" x-enumNames: - NotFound - MissingDestinationAddress - MissingCountryOrResidence - OnLockQueue - MissingRequiredSsrs - ContainsRestrictedSsrs - IsSelectee - MissingSeat - NotConfirmed - NotStandby - ContainsUnknownSsr - MissingApisRequirement - MissingDocuments - MissingName - MissingInfantName - MissingDateOfBirth - MissingInfantDateOfBirth - RestrictedInfantInLap enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 GovernmentProgramRequirements: type: object description: "Defines a government programs document requirements.\n \ \ " additionalProperties: false properties: governmentInstance: type: string description: "Identifies which instance of government security is associated\ \ with these specific requirements.\n " nullable: true requiredDocumentFields: type: array description: "The collection of required document fields to be collected.\n\ \ " nullable: true items: $ref: '#/components/schemas/GovernmentDocumentFieldType' additionalDataRequired: type: array description: "The collection of additional data that is required that are\ \ not related to documents.\n " nullable: true items: $ref: '#/components/schemas/GovernmentAdditionalDataType' programDescription: type: string description: "User-friendly label or description that should be used for\ \ all prompts and error messages\nto the user.\n " nullable: true messageType: type: string description: "Message type associated with these requirements.\n \ \ " nullable: true minVerifiedDocumentCount: type: integer description: "The minimum number of verified documents required.\n \ \ " format: int32 GovernmentDocumentFieldType: type: integer description: "Defines all the different travel document fields that a government\ \ program can require to be prompted/required.\n \n\n0 = FirstName\n\ 1 = MiddleName\n2 = LastName\n3 = Title\n4 = Suffix\n5 = DateOfBirth\n6 =\ \ BirthCountry\n7 = Gender\n8 = Nationality\n9 = Number\n10 = IssuingCountry\n\ 11 = ExpirationDate\n12 = IssuedDate\n13 = 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 GovernmentAdditionalDataType: type: integer description: "Defines the additional data that is required for a government\ \ program but are not collected with documents.\n \n\n0 = CountryOfResidence\n\ 1 = InTransitOrigin\n2 = InTransitDestination\n3 = DateOfBirth\n4 = Gender\n\ 5 = FirstName\n6 = LastName" x-enumNames: - CountryOfResidence - InTransitOrigin - InTransitDestination - DateOfBirth - Gender - FirstName - LastName enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 CheckinRestrictionType: type: integer description: "Defines the checkin level restriction types.\n \n\n\ 0 = Closed\n1 = NotOpened\n2 = PnrLocked\n3 = MarketingCodeShareNotAllowed\n\ 4 = NotPaidInFull\n5 = PaymentsPending\n6 = PaymentsPendingCustomerAction\n\ 7 = RestrictedOnAnotherSystem\n8 = NotAllowed\n9 = ApisNotAllowed\n10 = AppsNotAllowed\n\ 11 = SegmentNotFound\n12 = InvalidPrice\n13 = MissingEMDCoupon" x-enumNames: - Closed - NotOpened - PnrLocked - MarketingCodeShareNotAllowed - NotPaidInFull - PaymentsPending - PaymentsPendingCustomerAction - RestrictedOnAnotherSystem - NotAllowed - ApisNotAllowed - AppsNotAllowed - SegmentNotFound - InvalidPrice - MissingEMDCoupon enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 IJsonResponseOfApiConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ApiConfiguration' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ApiConfiguration: type: object description: "Defines the configuration (from the `appsettings` file) that the\ \ Digital API uses.\n " additionalProperties: false properties: passengerOptions: description: "Passenger-related configuration options.\n " nullable: true $ref: '#/components/schemas/PassengerConfiguration' PassengerConfiguration: type: object description: "Defines the passenger-related configuration options.\n \ \ " additionalProperties: false properties: infantSsrCode: type: string description: "The SSR code to be used for passenger infant (infant-on-lap)\ \ operations.\nThis SSR can only be sold via the /passengers/{passengerKey}/infant\ \ or via /trip and /trip/sell endpoints.\n " nullable: true OrderPaymentBase: type: object description: "Defines the order payment base details.\n " additionalProperties: false required: - type properties: type: type: string description: "The payment type.\n " minLength: 1 name: description: "The name on the payment.\n " nullable: true $ref: '#/components/schemas/Name' number: type: string description: "The number on the payment.\n " nullable: true expiration: type: string description: "The expiration date.\n " format: date-time nullable: true cvv: type: string description: "The CVV on the payment.\n " nullable: true amount: type: number description: "The applied payment amount.\n " format: decimal description: type: string description: "The payment description.\n " nullable: true issueNumber: type: string description: "The payment issue number.\n " nullable: true address: description: "The payments address.\n " nullable: true $ref: '#/components/schemas/Address' emailAddress: type: string description: "The provided email address.\n " format: email nullable: true phoneNumbers: type: array description: "The collection of phone numbers.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' Address: type: object description: "Defines a common address.\n " additionalProperties: false properties: lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true PhoneNumber: type: object description: "Defines a common phone number.\n " additionalProperties: false required: - number - type properties: number: type: string description: "The phone number without any formatting characters.\n \ \ " maxLength: 20 minLength: 0 type: description: "The phone number type.\n " $ref: '#/components/schemas/PhoneNumberType' PhoneNumberType: type: integer description: "Defines the types of phone numbers. Note: New Skies does not support\ \ Mobile for booking contacts.\n \n\n0 = Other\n1 = Home\n2 = Work\n\ 3 = Mobile\n4 = Fax" x-enumNames: - Other - Home - Work - Mobile - Fax enum: - 0 - 1 - 2 - 3 - 4 IJsonResponseOfAddOnAllowedPayments: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AddOnAllowedPayments' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AddOnAllowedPayments: type: object description: "Defines a components allowed payment types.\n " additionalProperties: false properties: componentKey: type: string description: "The unique component key.\n " nullable: true payments: type: array description: "The collection of allowed payment types.\n " nullable: true items: $ref: '#/components/schemas/ComponentPaymentType' ComponentPaymentType: type: object description: "Defines a component allowed payment type.\n " additionalProperties: false properties: type: type: string description: "The payment method type code.\n " nullable: true description: type: string description: "The payment description.\n " nullable: true modType: description: "The modulus check to perform.\n " $ref: '#/components/schemas/PaymentModType' expiration: description: "The field usage for expiration date.\n " $ref: '#/components/schemas/FieldUsage' cvv: description: "The field usage for CVV.\n " $ref: '#/components/schemas/FieldUsage' name: description: "The field usage for card holder name.\n " $ref: '#/components/schemas/FieldUsage' issueNumber: description: "The field usage for issue number.\n " $ref: '#/components/schemas/FieldUsage' PaymentModType: type: integer description: "Defines the different payment modulus types.\n \n\n\ 0 = None\n10 = Mod10\n11 = Mod11" x-enumNames: - None - Mod10 - Mod11 enum: - 0 - 10 - 11 FieldUsage: type: integer description: "Defines the field usage.\n \n\n0 = Prompt\n1 = DoNotPrompt\n\ 2 = Required" x-enumNames: - Prompt - DoNotPrompt - Required enum: - 0 - 1 - 2 IJsonResponseOfIDictionaryOfStringAndAddOnAllowedPayments: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: $ref: '#/components/schemas/AddOnAllowedPayments' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPassengerBag: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerBag' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerBag: type: object description: "Model information about the passenger's baggage.\n " additionalProperties: false properties: identifier: type: string description: "The unique transportation identifier.\n " maxLength: 4 minLength: 1 nullable: true nonStandard: type: boolean description: "Flag for marking a bag as a non-standard piece of luggage.\n\ \ " osTag: type: string description: "The OSTag in Bag object.\n " maxLength: 32 minLength: 0 nullable: true taggedToStation: type: string description: "The tagged to station in the bag object. This is the last\ \ station where\nthe bag is going to. For example, on a trip from SLC\ \ to JFK, JFK would\nbe the tagged to station value.\n " maxLength: 3 minLength: 3 nullable: true weight: type: integer description: "The Weight in Bag object.\n " maximum: 32767.0 minimum: 0.0 weightType: description: "The WeightType in Bag object.\n " $ref: '#/components/schemas/WeightType' baggageKey: type: string description: "Unique key for the baggage.\n " nullable: true type: type: string description: "The type of baggage.\n " maxLength: 6 minLength: 0 nullable: true osTagDate: type: string description: "The bag OS tag date.\n " format: date-time nullable: true stationCode: type: string description: "The bag station code.\n " maxLength: 3 minLength: 3 nullable: true taggedToCarrierCode: type: string description: "The bag tagged to carrier code.\n " maxLength: 3 minLength: 2 nullable: true IJsonResponseOfPassengerBag: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerBag' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BaggageEventCreateRequest: type: object description: "Represents the request to create baggage events.\n " additionalProperties: false required: - baggageEventCode - locationCode - toLocationCode properties: baggageEventCode: type: string description: "Baggage event code.\n " minLength: 1 eventText: type: string description: "Event text.\n " nullable: true locationCode: type: string description: "Baggage event location code.\n " minLength: 1 toLocationCode: type: string description: "Destination location code to which the baggage event pertains.\n\ \ " minLength: 1 IJsonResponseOfBaggageEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BaggageEvent' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BaggageEvent: type: object description: "Represents a baggage event.\n " additionalProperties: false properties: baggageEventKey: type: string description: "Baggage event key.\n " nullable: true baggageKey: type: string description: "Baggage key.\n " nullable: true createdDate: type: string description: "Created date.\n " format: date-time baggageEventCode: type: string description: "Baggage event code.\n " nullable: true eventText: type: string description: "Event text.\n " nullable: true locationCode: type: string description: "Baggage event location code.\n " nullable: true toLocationCode: type: string description: "Destination location code to which the baggage event pertains.\n\ \ " nullable: true IJsonResponseOfBaggageEventResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BaggageEventResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BaggageEventResponse: type: object description: "Represents the response from retrieving baggage events.\n \ \ " additionalProperties: false properties: events: type: array description: "List of baggage events.\n " nullable: true items: $ref: '#/components/schemas/BaggageEvent' PassengerBagRequest: type: object description: "A model for a request to update the passenger bags.\n \ \ " additionalProperties: false properties: bagCount: type: integer description: "The bag count for this request.\n " maximum: 32767.0 minimum: 1.0 iataIdentifier: type: string description: "The IATA identifier for this request.\n " maxLength: 3 minLength: 0 nullable: true limitedReleaseTag: type: boolean description: "Flag for marking a bag as a non-standard piece of luggage.\n\ \ " weightType: description: "Type of weight for the baggage weight.\n " nullable: true $ref: '#/components/schemas/WeightType' weight: type: integer description: "The baggage weight.\n " maximum: 32767.0 minimum: 0.0 nullable: true taggedToStation: type: string description: "The station to which the baggage will be tagged, if not the\ \ final destination.\n " maxLength: 3 minLength: 0 nullable: true PassengerManualBagRequest: type: object description: "A model for a request to update the passenger bags.\n \ \ " additionalProperties: false required: - weightType - taggedToCarrierCode - manualBagList properties: iataIdentifier: type: string description: "The IATA identifier for this request.\n " maxLength: 3 minLength: 0 nullable: true limitedReleaseTag: type: boolean description: "Flag for marking a bag as a non-standard piece of luggage.\n\ \ " weightType: description: "Type of weight for the baggage weight.\n " $ref: '#/components/schemas/WeightType' taggedToCarrierCode: type: string description: "The bag tagged to carrier code including OA codes.\n \ \ " maxLength: 3 minLength: 2 compartmentId: type: integer description: "Compartment ID the bag is assigned.\n " manualBagList: type: array description: "List of manually tagged bags to be added.\n " items: $ref: '#/components/schemas/ManualBag' taggedToStation: type: string description: "The station to which the baggage will be tagged, if not the\ \ final destination.\nNote: Must have the \"Allow Bag Tag Destination\ \ Mismatch\" role setting enabled to override baggage destination.\n \ \ " maxLength: 3 minLength: 3 nullable: true ManualBag: type: object description: "A base class for baggage models.\n " additionalProperties: false required: - osTag - taggedToStation - taggedToFlightNumber - weight properties: osTag: type: string description: "The manual bag tag (OSTag) of the bag being added.\n \ \ " maxLength: 32 minLength: 0 nonStandard: type: boolean description: "Flag for marking a bag as a non-standard piece of luggage.\n\ \ " taggedToStation: type: string description: "The tagged to station in the bag object. This is the last\ \ station where\nthe bag is going to. For example, on a trip from SLC\ \ to JFK, JFK would\nbe the tagged to station value.\n " maxLength: 3 minLength: 3 taggedToFlightNumber: type: string description: "A value representing the last segment's flight number leading\ \ to the bags final destination.\n " minLength: 1 weight: type: integer description: "The Weight in Bag object.\n " maximum: 32767.0 minimum: 0.0 baggageType: type: string description: "The baggage type field for the bag.\n " nullable: true PassengerBagCheckInRequest: type: object description: "A model for a request to check-in the passenger bags.\n \ \ " additionalProperties: false properties: weight: type: integer description: "The baggage weight.\n " maximum: 32767.0 minimum: 0.0 nullable: true weightType: description: "Type of weight for the baggage weight.\n " nullable: true $ref: '#/components/schemas/WeightType' baggageTypeCode: type: string description: "The baggage type code for the check-in request.\nThis can\ \ only be updated if the baggage weight is changed at the same time, and\ \ if\nthe baggage type code is active.\n " nullable: true PassengerBagGroupRequest: type: object description: "Request to move passengers to a different baggage group.\n \ \ " additionalProperties: false properties: baggageGroupNumber: type: integer description: "The baggage group number.\n " nullable: true IJsonResponseOfIListOfBaggageGroupMembership: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BaggageGroupMembership' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BaggageGroupMembership: type: object description: "The baggage group membership for a booking\n " additionalProperties: false properties: baggageGroupNumber: type: integer description: "Group number that will be assigned to bags added to the passengers\ \ PassengerKeys on the segments SegmentKeys.\n " format: int32 passengerKeys: type: array description: "The unique passenger key which will allow you to align group\ \ number to the segment from the GET /booking method.\n " nullable: true items: type: string segmentKeys: type: array description: "The unique segment key which will allow you to align group\ \ number to the segment from the GET /booking method.\n " nullable: true items: type: string IJsonResponseOfBoardingPassesM2D: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BoardingPassesM2D' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BoardingPassesM2D: type: object description: "The collection of M2D boarding passes.\n " additionalProperties: false properties: recordLocator: type: string description: "The record locator in reference.\n " nullable: true currencyCode: type: string description: "The currency code.\n " nullable: true contactPhoneNumber: type: string description: "The booking contacts phone number.\n " nullable: true boardingPasses: type: array description: "The collection of boarding passes with M2D bar codes.\n \ \ " nullable: true items: $ref: '#/components/schemas/BoardingPassM2D' BoardingPassM2D: type: object description: "Represents the boarding pass following the M2D barcode format.\n\ \ " additionalProperties: false properties: passenger: description: "The passenger details.\n " nullable: true $ref: '#/components/schemas/BoardingPassPassengerDetailsBase' userName: type: string description: "The user name of the logged in user.\n " nullable: true iataCode: type: string description: "The IATA code.\n " nullable: true fareBasisCode: type: string description: "The acting fare basis code.\n " nullable: true fareClass: type: string description: "The acting fare class.\n " nullable: true baseFare: type: number description: "The base fare amount.\n " format: decimal totalFare: type: number description: "The total fare amount.\n " format: decimal totalCost: type: number description: "The total cost amount.\n " format: decimal discountedFare: type: number description: "The discounted fare amount.\n " format: decimal totalTax: type: number description: "The total amount of tax.\n " format: decimal receiptNumber: type: string description: "The receipt number.\n " nullable: true serviceCharges: type: array description: "The collection of service charges for this segment.\n \ \ " nullable: true items: $ref: '#/components/schemas/ServiceCharge' segments: type: array description: "The collection of boarding pass segments.\n " nullable: true items: $ref: '#/components/schemas/BoardingPassSegment' barCode: type: string description: "The barcode (M2D format) for all the segments.\n \ \ " nullable: true BoardingPassPassengerDetailsBase: type: object description: "Represents a boarding pass passenger detail base, containing all\ \ the important passenger details for the boarding\npass.\n " additionalProperties: false properties: name: description: "The given name.\n " nullable: true $ref: '#/components/schemas/Name' isoName: description: "The given name converted to ISO standard.\n " nullable: true $ref: '#/components/schemas/Name' dateOfBirth: type: string description: "The date of birth.\n " format: date-time nullable: true gender: description: "The gender.\n " $ref: '#/components/schemas/Gender' documents: type: array description: "The collection of travel documents.\n " nullable: true items: $ref: '#/components/schemas/PassengerTravelDocument' type: type: string description: "The passenger type.\n " nullable: true selecteeString: type: string description: "The string that indicates a selectee.\n " nullable: true customerNumber: type: string description: "The customer number.\n " nullable: true score: description: "The passenger score.\n " nullable: true $ref: '#/components/schemas/BoardingPassPassengerScore' infant: description: "The passengers infant details if an infant exists.\n \ \ " nullable: true $ref: '#/components/schemas/BoardingPassInfantDetails' Gender: type: integer description: "Defines the different binary gender types.\n \n\n0\ \ = XX\n1 = Male\n2 = Female" x-enumNames: - XX - Male - Female enum: - 0 - 1 - 2 PassengerTravelDocument: type: object description: "Model representing a passenger travel document.\n " additionalProperties: false required: - documentTypeCode properties: documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: string description: "The issuer code for the travel document (country code).\n\ \ " maxLength: 3 minLength: 0 nullable: true birthCountry: type: string description: "The BirthCountry property.\n " nullable: true name: description: "The Name property.\n " nullable: true $ref: '#/components/schemas/Name' nationality: type: string description: "The Nationality property.\n " maxLength: 2 minLength: 0 nullable: true expirationDate: type: string description: "The date when this travel document expires.\n " format: date-time nullable: true number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 nullable: true issuedDate: type: string description: "The date this travel document was issued.\n " format: date-time nullable: true gender: description: "The travel document holder's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true declaredGender: type: string description: "The travel document holder's declared gender.\nThis will override\ \ the gender field on passenger or person POST, PUT, and PATCH requests.\n\ Note: Any value other than \"F\" will cause gender to be updated to Male\ \ by default to support compatibility with\nother systems.\nAdditionally\ \ you cannot change the declared gender and gender fields at the same\ \ time as declared gender\nwill override any gender field value regardless\ \ of the value passed in.\n " maxLength: 2 minLength: 0 nullable: true placeOfBirth: type: string description: "Represents the place of birth. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, numbers,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true placeOfIssue: type: string description: "Represents the place of issue. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true passengerTravelDocumentKey: type: string description: "A key that uniquely identifies a travel document in the context\ \ of a specific passenger.\n " nullable: true BoardingPassPassengerScore: type: object description: "Defines the boarding pass passenger score.\n " additionalProperties: false properties: name: type: string description: "The score name.\n " nullable: true code: type: string description: "The score code.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 nullable: true BoardingPassInfantDetails: type: object description: "Defines the boarding pass infant details.\n " additionalProperties: false properties: name: description: "The given name.\n " nullable: true $ref: '#/components/schemas/Name' isoName: description: "The given name converted to ISO standard.\n " nullable: true $ref: '#/components/schemas/Name' dateOfBirth: type: string description: "The date of birth.\n " format: date-time nullable: true gender: description: "The gender.\n " $ref: '#/components/schemas/Gender' documents: type: array description: "The collection of travel documents.\n " nullable: true items: $ref: '#/components/schemas/PassengerTravelDocument' ServiceCharge: type: object description: "Model that represents the fare service charge information.\n \ \ " additionalProperties: false properties: amount: type: number description: "The service charge amount.\n " format: decimal code: type: string description: "The service charge code.\n " nullable: true detail: type: string description: "The service charge detail.\n " maxLength: 10 minLength: 0 nullable: true type: description: "The service charge type.\n " $ref: '#/components/schemas/ChargeType' collectType: description: "The service charge collect type.\n " $ref: '#/components/schemas/CollectType' currencyCode: type: string description: "The service charge currency code.\n " maxLength: 3 minLength: 0 nullable: true foreignCurrencyCode: type: string description: "The service charge foreign currency code.\n " maxLength: 3 minLength: 0 nullable: true foreignAmount: type: number description: "The service charge foreign amount.\n " format: decimal ticketCode: type: string description: "The service charge ticket code.\n " maxLength: 3 minLength: 0 nullable: true ChargeType: type: integer description: "The type of a service charge.\n \n\n0 = FarePrice\n\ 1 = Discount\n2 = IncludedTravelFee\n3 = IncludedTax\n4 = TravelFee\n5 = Tax\n\ 6 = ServiceCharge\n7 = PromotionDiscount\n8 = ConnectionAdjustmentAmount\n\ 9 = AddOnsPrice\n10 = FarePoints\n11 = DiscountPoints\n16 = IncludedAddOnsFee\n\ 17 = AddOnsFee\n18 = AddOnsMarkup\n19 = FareSurcharge\n21 = AddOnsCancelFee\n\ 22 = Calculated\n23 = Note\n24 = Points\n25 = DynamicFareAdjustment" x-enumNames: - FarePrice - Discount - IncludedTravelFee - IncludedTax - TravelFee - Tax - ServiceCharge - PromotionDiscount - ConnectionAdjustmentAmount - AddOnsPrice - FarePoints - DiscountPoints - IncludedAddOnsFee - AddOnsFee - AddOnsMarkup - FareSurcharge - AddOnsCancelFee - Calculated - Note - Points - DynamicFareAdjustment enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 16 - 17 - 18 - 19 - 21 - 22 - 23 - 24 - 25 CollectType: type: integer description: "Used to identify the collect type of a service charge.\n \ \ \n\n0 = SellerChargeable\n1 = ExternalChargeable\n2 = SellerNonChargeable\n\ 3 = ExternalNonChargeable\n4 = ExternalChargeableImmediate" x-enumNames: - SellerChargeable - ExternalChargeable - SellerNonChargeable - ExternalNonChargeable - ExternalChargeableImmediate enum: - 0 - 1 - 2 - 3 - 4 BoardingPassSegment: type: object description: "Defines the boarding pass segment details.\n " additionalProperties: false properties: designator: description: "The transportation designator details based on the legs.\n\ \ " nullable: true $ref: '#/components/schemas/BoardingPassTransportationDesignator' transportationName: type: string description: "The name of the transportation company.\n " nullable: true departureGate: type: string description: "The scheduled departure gate.\n " nullable: true boardingTime: type: string description: "The scheduled boarding time.\n " format: date-time nullable: true type: description: "The type of the current segment.\n " $ref: '#/components/schemas/SegmentTypes' international: type: boolean description: "Flag indicating if the segment is international.\n \ \ " ticketNumber: type: string description: "The assigned passengers ticket number.\n " nullable: true infantTicketNumber: type: string description: "The assigned infants ticket number.\n " nullable: true ticketIndicator: type: string description: "The ticket indicator.\n " nullable: true cabinOfService: type: string description: "The assigned to cabin of service.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 nullable: true classOfService: type: string description: "The assigned to class of service.\n " nullable: true externalClassOfService: type: string description: "The externals reference class of service.\n " nullable: true fareClassName: type: string description: "The fare class name.\n " nullable: true productClassName: type: string description: "The product class name.\n " nullable: true externalRecordLocator: type: string description: "The assigned external record locator.\n " nullable: true program: description: "The applied passenger program if one existed.\n \ \ " nullable: true $ref: '#/components/schemas/BoardingPassProgram' hasInfant: type: boolean description: "Flag indicating if this segment has a infant.\n \ \ " identifier: description: "The transportation identifier details about the segment.\n\ \ " nullable: true $ref: '#/components/schemas/TransportationIdentifier' legs: type: array description: "The collection of legs.\n " nullable: true items: $ref: '#/components/schemas/BoardingPassLeg' externalIdentifier: description: "The external transportation identifier details about the segment.\n\ \ " nullable: true $ref: '#/components/schemas/BoardingPassTransportationIdentifier' arrivalTime: type: string description: "The estimated time of arrival.\nIf the UseEstimatedTimesOnBoardingPass\ \ is set to True, the arrival time will be the estimated arrival time.\n\ If the UseEstimatedTimesOnBoardingPass is set to False, the arrival time\ \ will be the scheduled arrival time.\n " format: date-time nullable: true departureTime: type: string description: "The estimated time of departure.\nIf the UseEstimatedTimesOnBoardingPass\ \ is set to True, the departure time will be the estimated departure time.\n\ If the UseEstimatedTimesOnBoardingPass is set to False, the departure\ \ time will be the scheduled departure time.\n " format: date-time nullable: true BoardingPassTransportationDesignator: type: object description: "Defines a boarding pass transportation designator.\n \ \ " additionalProperties: false properties: destination: type: string description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 nullable: true origin: type: string description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 nullable: true arrival: type: string description: "The arrival date and time local to the arrival station.\n\ \ " format: date-time departure: type: string description: "The departure date and time local to the departure station.\n\ \ " format: date-time destinationStationName: type: string description: "The destination stations localized name.\n " nullable: true originStationName: type: string description: "The origin stations localized name.\n " nullable: true SegmentTypes: type: integer description: "Indicates the type of a segment.\n \n\n0 = Normal\n\ 1 = CodeShareOperating\n2 = CodeShareMarketing\n3 = InterlineOutbound\n4 =\ \ InterlineInbound\n5 = Passive" x-enumNames: - Normal - CodeShareOperating - CodeShareMarketing - InterlineOutbound - InterlineInbound - Passive enum: - 0 - 1 - 2 - 3 - 4 - 5 BoardingPassProgram: type: object description: "Defines the boarding pass acting program.\n " additionalProperties: false properties: name: type: string description: "The programs name.\n " nullable: true number: type: string description: "The programs number.\n " nullable: true levelName: type: string description: "The programs level name.\n " nullable: true BoardingPassLeg: type: object description: "Defines the boarding pass leg details.\n " additionalProperties: false properties: seat: description: "The passengers assigned seats details.\n " nullable: true $ref: '#/components/schemas/BoardingPassSeatDetails' boarding: description: "The boarding details.\n " nullable: true $ref: '#/components/schemas/BoardingPassBoardingDetails' designator: description: "The legs transportation designator details.\n " nullable: true $ref: '#/components/schemas/TransportationDesignator' liftStatus: description: "The status of the leg for the passenger.\n " $ref: '#/components/schemas/LiftStatus' operatedByText: type: string description: "The legs operated by text.\n " nullable: true subjectToGovernmentApproval: type: boolean description: "Flag indicating if the leg is subject to government approval.\n\ \ " codeShareIndicator: type: string description: "The assigned code share indicator.\nPlease note that this\ \ should be a char and not a string.\n " maxLength: 1 nullable: true bppr: type: string description: "The homeland security government clearance auth code.\n \ \ " nullable: true identifier: description: "The legs transportation identifier.\n " nullable: true $ref: '#/components/schemas/BoardingPassTransportationIdentifier' bags: type: array description: "The collection of bags.\n " nullable: true items: $ref: '#/components/schemas/OperationBag' ssrs: type: array description: "The collection of SSR's.\n " nullable: true items: $ref: '#/components/schemas/SsrGlance' BoardingPassSeatDetails: type: object description: "Defines the boarding pass assigned seat details.\n " additionalProperties: false properties: column: type: string description: "The seat column.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 nullable: true row: type: integer description: "The seat row.\n " designator: type: string description: "The seat designator.\n " nullable: true BoardingPassBoardingDetails: type: object description: "Defines the boarding pass boarding details.\n " additionalProperties: false properties: boardingSequence: type: integer description: "The boarding sequence number.\n " boardingZone: type: integer description: "The boarding zone number.\n " externalBoardingZone: type: string description: "The external boarding zone.\n " nullable: true authorizationList: type: array description: "The boarding pass authorization list containing basic authorization\ \ information.\n " nullable: true items: $ref: '#/components/schemas/BoardingPassAuthorization' BoardingPassAuthorization: type: object description: "Defines the boarding pass authorization model.\n " additionalProperties: false properties: isInfant: type: boolean description: "Flag indicating if this authorization is for an infant.\n\ \ " authorizationStatus: type: string description: "The authorization status based on the current security driver.\ \ See driver name.\n " nullable: true driverName: type: string description: "The name of the security driver for this government message\ \ type. Used for override requests if necessary.\n " nullable: true boardingPassPrintText: type: string description: "The boarding pass print text for the driver. Ex) SSSS for\ \ Selectee or TSA pre-check.\n " nullable: true BoardingPassTransportationIdentifier: type: object description: "Defines a boarding pass transportation identifier.\n \ \ " additionalProperties: false required: - identifier - carrierCode properties: identifier: type: string description: "The unique transportation identifier.\n " maxLength: 4 minLength: 0 carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 opSuffix: type: string description: "The op suffix.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 nullable: true carrierName: type: string description: "The carriers name.\n " nullable: true OperationBag: type: object description: "Operation Bag.\n " additionalProperties: false properties: identifier: type: string description: "The unique transportation identifier.\n " maxLength: 4 minLength: 1 nullable: true nonStandard: type: boolean description: "Flag for marking a bag as a non-standard piece of luggage.\n\ \ " osTag: type: string description: "The OSTag in Bag object.\n " maxLength: 32 minLength: 0 nullable: true taggedToStation: type: string description: "The tagged to station in the bag object. This is the last\ \ station where\nthe bag is going to. For example, on a trip from SLC\ \ to JFK, JFK would\nbe the tagged to station value.\n " maxLength: 3 minLength: 3 nullable: true weight: type: integer description: "The Weight in Bag object.\n " maximum: 32767.0 minimum: 0.0 weightType: description: "The WeightType in Bag object.\n " $ref: '#/components/schemas/WeightType' operationBagKey: type: string description: "The baggage key\n " nullable: true baggageStatus: description: "The BaggageStatus in Bag object.\n " $ref: '#/components/schemas/BaggageStatus' checkInDate: type: string description: "The CheckInDate in Bag object.\n " format: date-time nullable: true compartment: type: integer description: "The CompartmentID in Bag object.\n " maximum: 32767.0 minimum: 0.0 taggedToStationCity: type: string description: "The tagged to station city in the bag object. This is the\ \ last city where\nthe bag is going to. For example, on a trip from SLC\ \ to JFK, New York would\nbe the tagged to station city value.\n \ \ " nullable: true baggageTypeCode: type: string description: "The baggage type code.\n " nullable: true BaggageStatus: type: integer description: "Baggage Status enumeration.\n \n\n0 = Default\n1 =\ \ Checked\n2 = Removed\n3 = Added\n4 = AddedPrinted" x-enumNames: - Default - Checked - Removed - Added - AddedPrinted enum: - 0 - 1 - 2 - 3 - 4 SsrGlance: type: object description: "Manifest Leg SSR.\n " additionalProperties: false properties: note: type: string description: "The additional information on the SSR that are not visible\ \ to passengers.\n " maxLength: 256 minLength: 0 nullable: true ssrCode: type: string description: "The unique code to identify an SSR.\n " maxLength: 4 minLength: 0 nullable: true ssrDetail: type: string description: "The additional information for the SSR as requested by the\ \ passenger.\n " maxLength: 20 minLength: 0 nullable: true BoardingPassPassengerFilterRequest: type: object description: "Defines the boarding pass request that is responsible for filtering\ \ what passengers to retrieve passes for.\n " additionalProperties: false properties: source: type: string description: "Name of the application requesting for boarding pass print.\n\ Please note that this should be a char and not a string.\nValid values\ \ are 'O', 'K', 'M', 'W', and ' '.\n " maxLength: 1 nullable: true skipLogToHistory: type: boolean description: "Whether to add event to history log.\n " passengerKeys: type: array description: "The selected passenger keys to be returned. If null all passengers\ \ will be returned that have been checked in.\n " nullable: true items: type: string IJsonResponseOfBoardingPassesS2D: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BoardingPassesS2D' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BoardingPassesS2D: type: object description: "Represents a collection of boarding passes following the S2D bar\ \ code format.\n " additionalProperties: false properties: recordLocator: type: string description: "The record locator in reference.\n " nullable: true currencyCode: type: string description: "The currency code.\n " nullable: true contactPhoneNumber: type: string description: "The booking contacts phone number.\n " nullable: true boardingPasses: type: array description: "The collection of boarding passes using S2D bar codes.\n \ \ " nullable: true items: $ref: '#/components/schemas/BoardingPassS2D' BoardingPassS2D: type: object description: "Represents a boarding pass for a specific passenger using the\ \ S2D barcode type.\n " additionalProperties: false properties: passenger: description: "The passenger details.\n " nullable: true $ref: '#/components/schemas/BoardingPassPassengerDetailsBase' userName: type: string description: "The user name of the logged in user.\n " nullable: true iataCode: type: string description: "The IATA code.\n " nullable: true fareBasisCode: type: string description: "The acting fare basis code.\n " nullable: true fareClass: type: string description: "The acting fare class.\n " nullable: true baseFare: type: number description: "The base fare amount.\n " format: decimal totalFare: type: number description: "The total fare amount.\n " format: decimal totalCost: type: number description: "The total cost amount.\n " format: decimal discountedFare: type: number description: "The discounted fare amount.\n " format: decimal totalTax: type: number description: "The total amount of tax.\n " format: decimal receiptNumber: type: string description: "The receipt number.\n " nullable: true serviceCharges: type: array description: "The collection of service charges for this segment.\n \ \ " nullable: true items: $ref: '#/components/schemas/ServiceCharge' segments: type: array description: "The collection of segments to display bar codes for.\n \ \ " nullable: true items: $ref: '#/components/schemas/BoardingPassS2DSegment' BoardingPassS2DSegment: type: object description: "Represents a boarding pass segment following the S2D barcode type.\ \ When using S2D format each segment will have a\nbarcode.\n " additionalProperties: false properties: designator: description: "The transportation designator details based on the legs.\n\ \ " nullable: true $ref: '#/components/schemas/BoardingPassTransportationDesignator' transportationName: type: string description: "The name of the transportation company.\n " nullable: true departureGate: type: string description: "The scheduled departure gate.\n " nullable: true boardingTime: type: string description: "The scheduled boarding time.\n " format: date-time nullable: true type: description: "The type of the current segment.\n " $ref: '#/components/schemas/SegmentTypes' international: type: boolean description: "Flag indicating if the segment is international.\n \ \ " ticketNumber: type: string description: "The assigned passengers ticket number.\n " nullable: true infantTicketNumber: type: string description: "The assigned infants ticket number.\n " nullable: true ticketIndicator: type: string description: "The ticket indicator.\n " nullable: true cabinOfService: type: string description: "The assigned to cabin of service.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 nullable: true classOfService: type: string description: "The assigned to class of service.\n " nullable: true externalClassOfService: type: string description: "The externals reference class of service.\n " nullable: true fareClassName: type: string description: "The fare class name.\n " nullable: true productClassName: type: string description: "The product class name.\n " nullable: true externalRecordLocator: type: string description: "The assigned external record locator.\n " nullable: true program: description: "The applied passenger program if one existed.\n \ \ " nullable: true $ref: '#/components/schemas/BoardingPassProgram' hasInfant: type: boolean description: "Flag indicating if this segment has a infant.\n \ \ " identifier: description: "The transportation identifier details about the segment.\n\ \ " nullable: true $ref: '#/components/schemas/TransportationIdentifier' legs: type: array description: "The collection of legs.\n " nullable: true items: $ref: '#/components/schemas/BoardingPassLeg' externalIdentifier: description: "The external transportation identifier details about the segment.\n\ \ " nullable: true $ref: '#/components/schemas/BoardingPassTransportationIdentifier' arrivalTime: type: string description: "The estimated time of arrival.\nIf the UseEstimatedTimesOnBoardingPass\ \ is set to True, the arrival time will be the estimated arrival time.\n\ If the UseEstimatedTimesOnBoardingPass is set to False, the arrival time\ \ will be the scheduled arrival time.\n " format: date-time nullable: true departureTime: type: string description: "The estimated time of departure.\nIf the UseEstimatedTimesOnBoardingPass\ \ is set to True, the departure time will be the estimated departure time.\n\ If the UseEstimatedTimesOnBoardingPass is set to False, the departure\ \ time will be the scheduled departure time.\n " format: date-time nullable: true barCode: type: string description: "The barcode data.\n " nullable: true IJsonResponseOfIDictionaryOfStringAndIListOfBaggageAllowance: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/BaggageAllowance' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BaggageAllowance: type: object description: "Defines a baggage allowance.\n " additionalProperties: false properties: baggageAllowanceKey: type: string description: "The unique identifier for the baggage allowance.\n \ \ " nullable: true journeyKey: type: string description: "The journey key.\n " nullable: true segmentKeys: type: array description: "The list of flight segment keys.\n " nullable: true items: type: string passengerKey: type: string description: "The passenger key.\n " nullable: true behavior: description: "The allowance behavior.\n " $ref: '#/components/schemas/BaggageAllowanceBehavior' typeCodes: type: array description: "The list of baggage type codes.\n " nullable: true items: type: string maximumPieces: type: integer description: "The maximum number of pieces.\n " nullable: true maximumWeightPerPiece: type: number description: "The maximum weight allowed per piece.\n " format: decimal nullable: true totalWeight: type: number description: "The total weight for all pieces.\n " format: decimal nullable: true weightType: description: "The weight type for MaximumWeightPerPiece and TotalWeight.\n\ \ " nullable: true $ref: '#/components/schemas/WeightType' baggageUsage: description: "The associated baggage usage details.\n " nullable: true $ref: '#/components/schemas/BaggageUsageDetails' BaggageAllowanceBehavior: type: integer description: "Baggage allowance behavior enumeration.\n \n\n0 = Default\n\ 1 = WeightSharing\n2 = PerPiece\n3 = PerPieceWithWeightSharing\n4 = NotAvailable" x-enumNames: - Default - WeightSharing - PerPiece - PerPieceWithWeightSharing - NotAvailable enum: - 0 - 1 - 2 - 3 - 4 BaggageUsageDetails: type: object description: "Defines baggage usage details.\n " additionalProperties: false properties: baggageAllowanceKey: type: string description: "The baggage allowance key.\n " nullable: true remainingPieces: type: integer description: "The remaining pieces.\n " nullable: true remainingWeight: type: number description: "The remaining total weight.\n " format: decimal nullable: true weightType: description: "The weight type for RemainingTotalWeight.\n " nullable: true $ref: '#/components/schemas/WeightType' IJsonResponseOfExternalBaggageAllowanceResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ExternalBaggageAllowanceResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ExternalBaggageAllowanceResponse: type: object description: "External baggage allowance information response.\n " additionalProperties: false properties: baggageAllowanceInformation: type: object description: "External baggage allowance information items.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/ExternalBaggageAllowanceInfo' disclaimer: type: string description: "Disclaimer text.\n " nullable: true ExternalBaggageAllowanceInfo: type: object description: "Information item used in a external baggage allowance information\ \ response.\n " additionalProperties: false properties: checkedBaggageAllowances: type: array description: "Allowances for checked baggage.\n " nullable: true items: $ref: '#/components/schemas/ExternalBaggageAllowanceCheckedDetail' carryOnBaggageAllowances: type: array description: "Allowances for carry-on baggage.\n " nullable: true items: $ref: '#/components/schemas/ExternalBaggageAllowanceCarryOnDetail' ExternalBaggageAllowanceCheckedDetail: type: object description: "External baggage allowance information details for checked baggage.\n\ \ " additionalProperties: false properties: mostSignificantCarrier: type: string description: "The carrier whose baggage allowance rules were used for assessment.\n\ \ " nullable: true usDotDisclosure: type: string description: "U.S. DOT disclosure text.\n " nullable: true freeAllowance: type: string description: "Short-hand description for free baggage that is allowed.\n\ \ " nullable: true passengerReference: type: string description: "Passenger being referred for this baggage allowance detail.\n\ Sets to \"EACH\" if this baggage allowance information matches all passengers\n\ for the specified origin and destination.\n " nullable: true passengerKey: type: string description: "The key of the passenger referred in the current state booking.\n\ \ " nullable: true bagTravel: type: string description: "The origin and destination traveled by checked or carry-on\ \ baggage.\n " nullable: true charges: type: array description: "Baggage charge details listed for each checked bag.\n \ \ " nullable: true items: $ref: '#/components/schemas/ExternalBaggageAllowanceCheckedCharge' ExternalBaggageAllowanceCheckedCharge: type: object description: "Charge details under each external baggage allowance information\ \ item.\n " additionalProperties: false properties: chargeDetail: type: string description: "Baggage allowance charge details.\n " nullable: true baggageWeight: description: "Baggage weight referred to by this charge detail in the request.\n\ \ " nullable: true $ref: '#/components/schemas/ExternalBaggageAllowanceWeight' ExternalBaggageAllowanceWeight: type: object description: "Weight item for requesting external baggage allowance information.\n\ \ " additionalProperties: false properties: weight: type: integer description: "Weight value.\n " format: int32 type: description: "Weight type.\n " $ref: '#/components/schemas/WeightType' ExternalBaggageAllowanceCarryOnDetail: type: object description: "External baggage allowance information details for carry-on baggage.\n\ \ " additionalProperties: false properties: mostSignificantCarrier: type: string description: "The carrier whose baggage allowance rules were used for assessment.\n\ \ " nullable: true usDotDisclosure: type: string description: "U.S. DOT disclosure text.\n " nullable: true freeAllowance: type: string description: "Short-hand description for free baggage that is allowed.\n\ \ " nullable: true passengerReference: type: string description: "Passenger being referred for this baggage allowance detail.\n\ Sets to \"EACH\" if this baggage allowance information matches all passengers\n\ for the specified origin and destination.\n " nullable: true passengerKey: type: string description: "The key of the passenger referred in the current state booking.\n\ \ " nullable: true bagTravel: type: string description: "The origin and destination traveled by checked or carry-on\ \ baggage.\n " nullable: true charges: type: array description: "Baggage charge details listed for each carry-on bag.\n \ \ " nullable: true items: $ref: '#/components/schemas/ExternalBaggageAllowanceCarryOnCharge' ExternalBaggageAllowanceCarryOnCharge: type: object description: "Charge details under each external baggage allowance information\ \ item for carry-on baggage.\n " additionalProperties: false properties: chargeDetail: type: string description: "Baggage allowance charge details.\n " nullable: true ExternalBaggageAllowanceRequest: type: object description: "External baggage allowance information request.\n " additionalProperties: false required: - baggageWeights properties: baggageWeights: type: array description: "The list of weight items that represent baggage that will\ \ be used for baggage allowance evaluation.\n " items: $ref: '#/components/schemas/ExternalBaggageAllowanceWeight' IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/CheckinPassengerLiftStatus' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CheckinPassengerLiftStatus: type: object description: "Defines a single passengers checkin status for a specific segment.\n\ \ " additionalProperties: false properties: status: description: "The lift status of the passenger for a specific segment.\n\ \ " $ref: '#/components/schemas/LiftStatus' identifier: description: "The transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' IJsonResponseOfCheckinRequirements: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CheckinRequirements' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CheckinRequirements: type: object description: "Defines the pre checkin requirements.\n " deprecated: true x-deprecatedMessage: Obsolete as of 4.4.4, please use the v2. additionalProperties: false properties: isValid: type: boolean description: "Flag indicating if the ability to checkin is valid.\n \ \ " passengers: type: object description: "The collection of passengers and there requirements to checkin.\n\ \ " nullable: true additionalProperties: $ref: '#/components/schemas/CheckinPassengerRequirements' governmentProgramRequirements: type: object description: "The collection of government programs requirements.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/GovernmentProgramRequirements' restrictions: type: array description: "The list of any non passenger related checkin restrictions\ \ that will restrict the desired segments to be checked\nin.\nThe checkin\ \ restriction type = ('Closed', 'NotOpened', 'PnrLocked', 'MarketingCodeShareNotAllowed',\n\ 'NotPaidInFull', 'PaymentsPending',\n'PaymentsPendingCustomerAction',\ \ 'RestrictedOnAnotherSystem', 'NotAllowed', 'ApisNotAllowed', 'AppsNotAllowed',\n\ 'SegmentNotFound', 'InvalidPrice').\n " nullable: true items: $ref: '#/components/schemas/CheckinRestrictionType' CheckinPassengerRequirements: type: object description: "Defines an individual passengers checkin requirements.\n \ \ " deprecated: true x-deprecatedMessage: Obsolete as of 4.4.4, please use the v2. additionalProperties: false properties: isValid: type: boolean description: "Flag indicating if the specific passenger checkin is valid.\n\ \ " passengerKey: type: string description: "The associated passenger key.\n " nullable: true documentRequirements: description: "The passengers document requirements.\n " nullable: true $ref: '#/components/schemas/CheckinDocumentRequirements' addressRequirements: description: "The passengers address requirements.\n " nullable: true $ref: '#/components/schemas/CheckinAddressRequirements' invalidSsrs: type: array description: "The collection of checkin restricted/invalid SSR's the passenger\ \ contains.\n " nullable: true items: type: string requiredSsrs: type: array description: "The collection of checkin required SSR's the passenger is\ \ missing for each segment.\n " nullable: true items: $ref: '#/components/schemas/CheckinMissingSegmentRequiredSsr' restrictions: type: array description: "The list of passengers restrictions that will restrict passenger\ \ from checkin.\n " nullable: true items: $ref: '#/components/schemas/CheckinPassengerRestriction' CheckinDocumentRequirements: type: object description: "Defines a passenger checkin document requirements.\n \ \ " deprecated: true x-deprecatedMessage: Obsolete as of 4.4.4, please use the v2. additionalProperties: false properties: isValid: type: boolean description: "Flag indicating if the checkin document requirements are all\ \ meet and ready/valid for checkin.\n " documentsOnFile: type: array description: "The collection of document type codes that already exist on\ \ the passenger.\n " nullable: true items: type: string unhandledDocuments: type: array description: "The collection of unhandled documents at each acting government\ \ entity.\n " nullable: true items: $ref: '#/components/schemas/GovernmentPassengerDocumentRequirement' documentVerificationRequired: type: boolean description: "Boolean to confirm documents need to be verified.\n***Note***\n\ If it is TRUE, document verification is required.\nIf it is FALSE, it\ \ could be\n1) No document verification is required, or\n2) The given\ \ Travel Documents Type and Count matches the government program driver\ \ requirements, BUT this\ndoes not ensure that all government security\ \ document requirements have been met.\n " GovernmentPassengerDocumentRequirement: type: object description: "Defines a specific government document requirements for a specific\ \ passenger.\n " deprecated: true x-deprecatedMessage: Obsolete as of 4.4.4, please use the v2. additionalProperties: false properties: governmentInstance: type: string description: "Identifies which instance of government security is associated\ \ with these specific requirements.\n " nullable: true numberOfMissingDocuments: type: integer description: "The number of documents still missing.\n " eligibleDocuments: type: array description: "The collection of eligible documents that have not already\ \ been added by the passenger.\n " nullable: true items: $ref: '#/components/schemas/GovernmentDocumentRequirement' CheckinPassengersRequest: type: object description: "Defines the checkin passengers request.\n " additionalProperties: false required: - passengers properties: seatsRequired: type: boolean description: "The flag indicating whether a seat is required for checkin.\n\ \ " nullable: true skipSecurityChecks: type: boolean description: "The flag indicating whether checkin requirement validation\ \ will be skipped.\n " nullable: true isStandby: type: boolean description: "The flag indicating whether the collection of passengers are\ \ for standby checkin.\n " nullable: true passengers: type: array description: "The collection of passengers to checkin.\n " items: $ref: '#/components/schemas/CheckinPassengerRequest' CheckinPassengerRequest: type: object description: "Defines the individual passenger checkin request.\n \ \ " additionalProperties: false required: - passengerKey properties: passengerKey: type: string description: "The unique passenger key being checked in.\n " minLength: 1 transitType: description: "The passengers transit type.\n " nullable: true $ref: '#/components/schemas/TransitType' processApps: type: boolean description: "Flag indicating to process APPS.\n " nullable: true verifiedReference: type: string description: "The value specifying the verified travel document(s) associated\ \ with this checkin.\n " nullable: true TransitType: type: integer description: "Defines the different type of transit states.\n \n\n\ 0 = Default\n1 = Origin\n2 = Destination\n3 = Both" x-enumNames: - Default - Origin - Destination - Both enum: - 0 - 1 - 2 - 3 IJsonResponseOfIListOfClassAvailability: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ClassAvailability' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ClassAvailability: type: object description: "Defines a class of service availability for a segment.\n \ \ " additionalProperties: false properties: transportationIdentifier: description: "The identifier for the segment.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' departureTime: type: string description: "The standard time of departure.\n " format: date-time nullable: true origin: type: string description: "The departure station.\n " nullable: true destination: type: string description: "The arrival station.\n " nullable: true classesOfService: type: array description: "The list of available classes.\n " nullable: true items: $ref: '#/components/schemas/ClassModify' segmentKey: type: string description: "The segment key this associates to.\n " nullable: true ClassModify: type: object description: "Defines the class modify information.\n " additionalProperties: false properties: classModifyKey: type: string description: "The class modify key.\n " nullable: true originalClassOfService: type: string description: "The current/original class of service.\n " nullable: true newClassOfService: type: string description: "The new/changed class of service.\n " nullable: true available: type: integer description: "The remaining downgrade count.\n " fee: description: "The passenger fee details.\n " nullable: true $ref: '#/components/schemas/PassengerFee' PassengerFee: type: object description: "Model representing passenger fee information.\n " additionalProperties: false required: - code properties: isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or\ \ not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n\ \ " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external\ \ or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: string description: "The fee detail.\n " maxLength: 32 minLength: 0 nullable: true passengerFeeKey: type: string description: "The passenger fee key.\n " nullable: true override: type: boolean description: "The fee override.\n " flightReference: type: string description: "The flight reference which signifies a link to a segment and\ \ or leg.\n " maxLength: 22 minLength: 0 nullable: true note: type: string description: "The fee notes.\n " maxLength: 128 minLength: 0 nullable: true createdDate: type: string description: "The created date for the fee.\n " format: date-time nullable: true isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: array description: "The list of service charges for the fee.\n " nullable: true items: $ref: '#/components/schemas/ServiceCharge' type: description: "The fee type.\n " $ref: '#/components/schemas/FeeType' ssrCode: type: string description: "The SSR code.\n " nullable: true ssrNumber: type: integer description: "The fee SSR number.\n " paymentNumber: type: integer description: "The fee payment number.\n " FeeType: type: integer description: "Enumeration representing all the different fee types.\n \ \ \n\n0 = All\n1 = Tax\n2 = TravelFee\n3 = ServiceFee\n4 = PaymentFee\n\ 5 = PenaltyFee\n6 = SsrFee\n7 = NonFlightServiceFee\n8 = UpgradeFee\n9 = SeatFee\n\ 10 = BaseFare\n11 = SpoilageFee\n12 = NameChangeFee\n13 = ConvenienceFee\n\ 14 = BaggageFee\n15 = FareSurcharge\n16 = PromotionDiscount\n17 = ServiceBundle\n\ 18 = ExtraBagFee\n19 = ATPCOBagFee" x-enumNames: - All - Tax - TravelFee - ServiceFee - PaymentFee - PenaltyFee - SsrFee - NonFlightServiceFee - UpgradeFee - SeatFee - BaseFare - SpoilageFee - NameChangeFee - ConvenienceFee - BaggageFee - FareSurcharge - PromotionDiscount - ServiceBundle - ExtraBagFee - ATPCOBagFee enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 FeePricingMode: type: integer description: "The fee pricing mode enumeration.\n \n\n0 = MonetaryOnly\n\ 1 = PointsOnly" x-enumNames: - MonetaryOnly - PointsOnly enum: - 0 - 1 ClassModifyBaseRequest: type: object description: "Defines the base class modify request.\n " additionalProperties: false properties: inventoryControl: description: "The reserving inventory action of an upgrade or downgrade\ \ once sold by the system.\n " nullable: true $ref: '#/components/schemas/InventoryControlType' feePricingMode: description: "Fee pricing mode.\n " nullable: true $ref: '#/components/schemas/FeePricingMode' collectedCurrencyCode: type: string description: "Collected currency code.\n " maxLength: 3 minLength: 0 nullable: true feeOverride: type: boolean description: "Fee override flag. Applicable role settings that allow waiving\ \ or overriding\nof upgrade/downgrade fees are required when this is enabled.\n\ \ " nullable: true InventoryControlType: type: integer description: "Defines the different ways inventory is held at the time of sell.\n\ \ \n\n0 = HoldSpace\n1 = SoftHoldSpace\n2 = ClaimSpace\n3 = OversellSpace\n\ 4 = StandBy" x-enumNames: - HoldSpace - SoftHoldSpace - ClaimSpace - OversellSpace - StandBy enum: - 0 - 1 - 2 - 3 - 4 IJsonResponseOfIListOfBookingComment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BookingComment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingComment: type: object description: "Defines a booking comment.\n " additionalProperties: false properties: type: description: "Indicates where the comment will be seen.\n " $ref: '#/components/schemas/CommentType' text: type: string description: "The text of the comment.\n " nullable: true createdDate: type: string description: "The created date of the comment.\n " format: date-time nullable: true pointOfSale: description: "The point of sale for the comment.\n " nullable: true $ref: '#/components/schemas/PointOfSale' commentKey: type: string description: "The comment key.\n " nullable: true CommentType: type: integer description: "Comment Types Enumerations\n \n\n0 = Default\n1 = Itinerary\n\ 2 = Manifest\n3 = Alert\n4 = Archive\n5 = Voucher" x-enumNames: - Default - Itinerary - Manifest - Alert - Archive - Voucher enum: - 0 - 1 - 2 - 3 - 4 - 5 PointOfSale: type: object description: "Model related to the point of sale. This is for read-only operations.\n\ \ " additionalProperties: false properties: agentCode: type: string description: "The point of sale agent code.\n " nullable: true domainCode: type: string description: "The point of sale domain code.\n " nullable: true locationCode: type: string description: "The point of sale location code.\n " nullable: true organizationCode: type: string description: "The point of sale organization code.\n " nullable: true IJsonResponseOfBooking: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Booking' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Booking: type: object description: "Represents a full booking object.\n " additionalProperties: false properties: selfServiceMoveAvailable: type: boolean description: "The flag indicating whether self-service move is allowed.\n\ \ " bookingKey: type: string description: "The unique identifier.\n " nullable: true recordLocator: type: string description: "The alphanumeric identifier assigned to a reservation when\ \ the record is created (created means when the booking\nwas submitted\ \ to the database).\n " maxLength: 12 minLength: 0 nullable: true currencyCode: type: string description: "The currency in which the booking is created and priced.\n\ \ " maxLength: 3 minLength: 0 nullable: true systemCode: type: string description: "The GDS/CRS code that requested the booking.\n " maxLength: 3 minLength: 0 nullable: true groupName: type: string description: "The group name of the booking.\n " nullable: true locators: description: "Booking locators used to define a booking.\n " nullable: true $ref: '#/components/schemas/BookingRecordLocators' info: description: "Informational about the booking.\n " nullable: true $ref: '#/components/schemas/BookingInfo' sales: description: "Details about the point of sale.\n " nullable: true $ref: '#/components/schemas/BookingSales' typeOfSale: description: "Information about the type of sale the booking was.\n \ \ " nullable: true $ref: '#/components/schemas/TypeOfSale' hold: description: "Defines the hold expiration.\n " nullable: true $ref: '#/components/schemas/BookingHold' breakdown: description: "The booking pricing breakdown.\n " nullable: true $ref: '#/components/schemas/BookingPriceBreakdown' receivedBy: description: "Details about what received the booking commit.\n \ \ " nullable: true $ref: '#/components/schemas/ReceivedByInfo' contacts: type: object description: "The contacts on the booking by unique the contact type code.\n\ Please note that this should be a dictionary of char keys and not a dictionary\ \ of string keys.\n " nullable: true additionalProperties: $ref: '#/components/schemas/Contact' passengers: type: object description: "The list of passengers and information.\n " nullable: true additionalProperties: $ref: '#/components/schemas/Passenger' journeys: type: array description: "The list of journeys and information.\n " nullable: true items: $ref: '#/components/schemas/Journey' comments: type: array description: "The list of associated comments.\n " nullable: true items: $ref: '#/components/schemas/BookingComment' queues: type: array description: "The list of information indicating which queue the booking\ \ is present in.\n " nullable: true items: $ref: '#/components/schemas/BookingQueueInfo' history: type: array description: "The history of the booking since it was loaded into state.\n\ \ " nullable: true items: $ref: '#/components/schemas/BookingHistory' payments: type: array description: "The list of applied payments.\n " nullable: true items: $ref: '#/components/schemas/Payment' addOns: type: object description: "The list of components.\n " nullable: true additionalProperties: $ref: '#/components/schemas/AddOn' orders: type: array description: "The list of booking orders.\n " nullable: true items: $ref: '#/components/schemas/BookingOrder' BookingRecordLocators: type: object description: "Defines the booking's unique identifiers.\n " additionalProperties: false properties: numericRecordLocator: type: string description: "The alphanumeric identifier generated when the booking is\ \ retrieved from the alphanumeric record locator value that\nwas assigned.\n\ \ " maxLength: 12 minLength: 0 nullable: true parentRecordLocator: type: string description: "The record locator of the booking where the current booking\ \ resulted from.\n " maxLength: 12 minLength: 0 nullable: true parentId: type: integer description: "The unique identifier of the booking where the current booking\ \ resulted from.\n " format: int64 recordLocators: type: array description: "The list of other reservations that can be used as cross reference\ \ for the booking.\n " nullable: true items: $ref: '#/components/schemas/RecordLocator' RecordLocator: type: object description: "Defines a unique locator for reference.\n " additionalProperties: false properties: systemDomainCode: type: string description: "The system domain code.\n " maxLength: 3 minLength: 0 nullable: true bookingSystemCode: type: string description: "The system code of where the booking was created.\n \ \ " maxLength: 3 minLength: 0 nullable: true hostedCarrierCode: type: string description: "The hosted carrier's code.\n " maxLength: 3 minLength: 0 nullable: true recordLocatorKey: type: string description: "The unique record locator key.\n " nullable: true recordCode: type: string description: "The record code.\n " maxLength: 12 minLength: 0 nullable: true owningSystemCode: type: string description: "The owning system code for the booking.\n " maxLength: 3 minLength: 0 nullable: true interactionPurpose: type: string description: "The interaction purpose.\n " maxLength: 2 minLength: 0 nullable: true BookingInfo: type: object description: "Describes general booking details.\n " additionalProperties: false properties: status: description: "The status of the entire booking.\n " $ref: '#/components/schemas/BookingStatus' paidStatus: description: "The status of the applied payments.\n " $ref: '#/components/schemas/PaidStatus' priceStatus: description: "The pricing status of the booking.\n " $ref: '#/components/schemas/PriceStatus' profileStatus: description: "The booking profiling status.\n " $ref: '#/components/schemas/BookingProfileStatus' bookingType: type: string description: "Identifies the type (Default, GDS, CodeShare, ect) of the\ \ booking set during the commit process.\n " nullable: true channelType: description: "The channel that is responsible for created the booking.\n\ \ " $ref: '#/components/schemas/ChannelType' bookedDate: type: string description: "The UTC date and time the booking was originally created.\n\ \ " format: date-time nullable: true createdDate: type: string description: "The UTC date and time of when the booking was created.\n \ \ " format: date-time nullable: true expirationDate: type: string description: "The UTC date and time indicating when the booking will not\ \ be returned when retrieved by a GDS/GRS.\n " format: date-time nullable: true modifiedDate: type: string description: "The UTC date and time when the booking was last updated on\ \ the server.\n " format: date-time nullable: true modifiedAgentId: type: integer description: "The last agent ID who modified the booking.\n " format: int64 createdAgentId: type: integer description: "The agent ID that created the booking.\n " format: int64 owningCarrierCode: type: string description: "Identifies which carrier is financially responsible for the\ \ booking and payment.\n " maxLength: 3 minLength: 2 nullable: true changeAllowed: type: boolean description: "The flag indicating whether the booking can be changed.\n\ \ " createdUserKey: type: string description: "The user key of the agent ID who created the booking, which\ \ can be used anywhere the userKey is accepted.\n " nullable: true modifiedUserKey: type: string description: "The modified user key of the agent ID who modified the booking\ \ last, which can be used anywhere the userKey is\naccepted.\n \ \ " nullable: true BookingStatus: type: integer description: "Booking Status Enumeration\n \n\n0 = Default\n1 = Hold\n\ 2 = Confirmed\n3 = Closed\n4 = HoldCanceled\n5 = PendingArchive\n6 = Archived\n\ 7 = ArchivedPrivate\n777 = ProcessedForArchive" x-enumNames: - Default - Hold - Confirmed - Closed - HoldCanceled - PendingArchive - Archived - ArchivedPrivate - ProcessedForArchive enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 777 PaidStatus: type: integer description: "Paid status enumeration.\n \n\n0 = UnderPaid\n1 = PaidInFull\n\ 2 = OverPaid" x-enumNames: - UnderPaid - PaidInFull - OverPaid enum: - 0 - 1 - 2 PriceStatus: type: integer description: "Describes the fare pricing status\n \n\n0 = Invalid\n\ 1 = Override\n2 = Valid" x-enumNames: - Invalid - Override - Valid enum: - 0 - 1 - 2 BookingProfileStatus: type: integer description: "Defines the profiling status of the booking.\n \n\n\ 0 = Default\n1 = KnownIndividual\n2 = ResolutionGroup\n3 = SelecteeGroup\n\ 4 = NotUsed\n5 = FailureGroup\n6 = RandomSelectee\n7 = Exempt" x-enumNames: - Default - KnownIndividual - ResolutionGroup - SelecteeGroup - NotUsed - FailureGroup - RandomSelectee - Exempt enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 ChannelType: type: integer description: "Defines the available channel types doing invoking the communication\ \ with the server.\n \n\n0 = Default\n1 = Direct\n2 = Web\n3 =\ \ Gds\n4 = Api\n5 = DigitalApi\n6 = DigitalWeb\n7 = Ndc" x-enumNames: - Default - Direct - Web - Gds - Api - DigitalApi - DigitalWeb - Ndc enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 BookingSales: type: object description: "Defines the different point of sale information.\n " additionalProperties: false properties: created: description: "Contains the details about the agent and organization information\ \ that created this booking.\n " nullable: true $ref: '#/components/schemas/PointOfSale' source: description: "Contains the details about the agent and organization information\ \ that referred the created booking.\n " nullable: true $ref: '#/components/schemas/BookingPointOfSale' modified: description: "Contains the details about the agent and organization information\ \ that made the last set of changes.\n " nullable: true $ref: '#/components/schemas/PointOfSale' BookingPointOfSale: type: object description: "Model related to the point of sale.\n " additionalProperties: false properties: agentCode: type: string description: "The point of sale agent code.\n " nullable: true domainCode: type: string description: "The point of sale domain code.\n " nullable: true locationCode: type: string description: "The point of sale location code.\n " nullable: true organizationCode: type: string description: "The point of sale organization code.\n " nullable: true isoCountryCode: type: string description: "Two character country code, optionally supplied in GDS message\n\ \ " nullable: true sourceSystemCode: type: string description: "Two character system code, optionally supplied in GDS message\n\ \ " nullable: true TypeOfSale: type: object description: "Defines the type of sale values.\n " additionalProperties: false properties: residentCountry: type: string description: "The resident country.\n " maxLength: 2 minLength: 0 nullable: true promotionCode: type: string description: "The promo code that was applied.\n " maxLength: 8 minLength: 0 nullable: true fareTypes: type: array description: "The collection of fare types applied.\n " nullable: true items: type: string BookingHold: type: object description: "Defines the booking hold expiration.\n " additionalProperties: false properties: expiration: type: string description: "Defines the hold date and time expiration.\n " format: date-time nullable: true BookingPriceBreakdown: type: object description: "Defines the booking top level pricing breakdown.\n " additionalProperties: false properties: balanceDue: type: number description: "The booking balance due.\n " format: decimal pointsBalanceDue: type: number description: "The booking points balance due.\n " format: decimal authorizedBalanceDue: type: number description: "The bookings authorized balance due.\n " format: decimal totalAmount: type: number description: "The booking total amount.\n " format: decimal totalPoints: type: number description: "The booking total points.\n " format: decimal totalToCollect: type: number description: "The booking total to collect.\n " format: decimal totalPointsToCollect: type: number description: "The booking total points to collect.\n " format: decimal totalCharged: type: number description: "The total amount charged.\n " format: decimal passengerTotals: description: "The calculated price breakdown for all passengers.\n \ \ " nullable: true $ref: '#/components/schemas/PassengerPriceBreakdownBase' passengers: type: object description: "The individual collection of passenger price breakdowns.\n\ \ " nullable: true additionalProperties: $ref: '#/components/schemas/PassengerPriceBreakdown' journeyTotals: description: "The calculated price breakdown for all journeys.\n \ \ " nullable: true $ref: '#/components/schemas/JourneyPriceBreakdownBase' journeys: type: object description: "The individual collection of journey price breakdown.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/JourneyPriceBreakdown' addOnTotals: description: "The total amounts charged for each type of AddOn.\n \ \ " nullable: true $ref: '#/components/schemas/AddOnPriceBreakdown' PassengerPriceBreakdownBase: type: object description: "Defines the combined booking passengers pricing breakdown.\n \ \ " additionalProperties: false properties: services: description: "The charge breakdown of the service fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' specialServices: description: "The charge breakdown of the special service requests.\n \ \ " nullable: true $ref: '#/components/schemas/ChargeBreakdown' seats: description: "The charge breakdown of seat fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' upgrades: description: "The charge breakdown of upgrade fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' spoilage: description: "The charge breakdown of spoilage fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' nameChanges: description: "The charge breakdown of name change fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' convenience: description: "The charge breakdown of convenience fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' infant: description: "The charge breakdown of infant fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' totalCost: type: number description: "The total cost for the passenger.\nThese values are only populated\ \ by NewSkies after a booking commit\n " format: decimal nullable: true ChargeBreakdown: type: object description: "Defines a charge breakdown.\n " additionalProperties: false properties: total: type: number description: "The total amount.\n " format: decimal nullable: true taxes: type: number description: "The total fee taxes amount.\n " format: decimal nullable: true adjustments: type: number description: "The total adjusted amount.\n " format: decimal nullable: true charges: type: array description: "The collection of charges within the calculation.\n \ \ " nullable: true items: $ref: '#/components/schemas/ServiceCharge' PassengerPriceBreakdown: type: object description: "Defines the individual passenger-level pricing breakdown.\n \ \ " additionalProperties: false properties: services: description: "The charge breakdown of the service fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' specialServices: description: "The charge breakdown of the special service requests.\n \ \ " nullable: true $ref: '#/components/schemas/ChargeBreakdown' seats: description: "The charge breakdown of seat fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' upgrades: description: "The charge breakdown of upgrade fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' spoilage: description: "The charge breakdown of spoilage fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' nameChanges: description: "The charge breakdown of name change fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' convenience: description: "The charge breakdown of convenience fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' infant: description: "The charge breakdown of infant fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' totalCost: type: number description: "The total cost for the passenger.\nThese values are only populated\ \ by NewSkies after a booking commit\n " format: decimal nullable: true passengerKey: type: string description: "The unique passenger number.\n " nullable: true JourneyPriceBreakdownBase: type: object description: "Defines the journey price breakdown base.\n " additionalProperties: false properties: totalAmount: type: number description: "The journey price total.\n " format: decimal totalPoints: type: number description: "The journey points total.\n " format: decimal totalTax: type: number description: "The journey taxes total.\n " format: decimal totalDiscount: type: number description: "The journey discount total.\n " format: decimal JourneyPriceBreakdown: type: object description: "Defines a specifics journey pricing breakdown.\n " additionalProperties: false properties: totalAmount: type: number description: "The journey price total.\n " format: decimal totalPoints: type: number description: "The journey points total.\n " format: decimal totalTax: type: number description: "The journey taxes total.\n " format: decimal totalDiscount: type: number description: "The journey discount total.\n " format: decimal journeyKey: type: string description: "The unique journey key.\n " nullable: true AddOnPriceBreakdown: type: object description: "Defines the addOn price breakdown.\n " additionalProperties: false properties: car: type: number description: "The car price total.\n " format: decimal nullable: true hotel: type: number description: "The hotel price total.\n " format: decimal nullable: true activities: type: number description: "The activities price total.\n " format: decimal nullable: true ReceivedByInfo: type: object description: "Defines the received by information.\n " additionalProperties: false properties: receivedBy: type: string description: "The received by name.\n " maxLength: 64 minLength: 0 nullable: true latestReceivedBy: type: string description: "The latest received by name.\n " maxLength: 64 minLength: 0 nullable: true receivedReference: type: string description: "The received by reference.\n " maxLength: 20 minLength: 0 nullable: true latestReceivedReference: type: string description: "The latest received by reference.\n " maxLength: 20 minLength: 0 nullable: true referralCode: type: string description: "The referral code.\n " maxLength: 12 minLength: 0 nullable: true Contact: type: object description: "Contact model describing a person contact information.\n \ \ " additionalProperties: false required: - contactTypeCode properties: phoneNumbers: type: array description: "The collection of phone numbers.\nSupported types: Home, Work,\ \ Fax, Other.\nThis collections can only contain one number for each supported\ \ type.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 nullable: true address: description: "The contact address.\n " nullable: true $ref: '#/components/schemas/Address' emailAddress: type: string description: "The email address of the contact.\n " nullable: true customerNumber: type: string description: "The customer number.\n " maxLength: 20 minLength: 0 nullable: true sourceOrganization: type: string description: "Source organization.\n " maxLength: 10 minLength: 0 nullable: true distributionOption: description: "The contact distribution option.\n " nullable: true $ref: '#/components/schemas/DistributionOption' notificationPreference: description: "The notification preference of the contact.\n " nullable: true $ref: '#/components/schemas/NotificationPreference' companyName: type: string description: "The company name.\n " maxLength: 64 minLength: 0 nullable: true name: description: "The contact's name.\n " nullable: true $ref: '#/components/schemas/Name' contactTypeCode: type: string description: "The contact type code. There can only be one contact of a\ \ specific type on the booking.\nTypically only one contact is used. Null\ \ values will be replaced by the primary contact type code.\nPlease note\ \ that this should be a char and not a string.\n " maxLength: 1 minLength: 1 DistributionOption: type: integer description: "This enumeration specifies the distribution methods for sending\ \ notifications.\n \n\n0 = None\n1 = Mail\n2 = Email\n3 = Fax\n\ 4 = MailFax\n5 = Airport\n6 = Hold\n7 = Print" x-enumNames: - None - Mail - Email - Fax - MailFax - Airport - Hold - Print enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 NotificationPreference: type: integer description: "Describes types of notifications the user would prefer.\n \ \ \n\n0 = None\n1 = Promotional" x-enumNames: - None - Promotional enum: - 0 - 1 Passenger: type: object description: "Model information representing a passenger on a journey.\n \ \ " additionalProperties: false required: - passengerTypeCode properties: customerNumber: type: string description: "The passenger customer number.\n " maxLength: 20 minLength: 0 nullable: true name: description: "The passenger's name.\n " nullable: true $ref: '#/components/schemas/Name' discountCode: type: string description: "The discount code associated with the passenger type.\n \ \ " maxLength: 8 minLength: 0 nullable: true program: description: "The passenger programs.\n " nullable: true $ref: '#/components/schemas/PassengerProgram' info: description: "Additional passenger information.\n " nullable: true $ref: '#/components/schemas/PassengerInformation' passengerKey: type: string description: "The unique passenger identifier key.\n " nullable: true passengerAlternateKey: type: string description: "The passenger alternate key is used to identify a passenger\ \ post commit of the booking.\n " nullable: true fees: type: array description: "Fees.\n " nullable: true items: $ref: '#/components/schemas/PassengerFee' passengerTypeCode: type: string description: "The passenger type code.\n " minLength: 1 bags: type: array description: "Passenger bags.\n " nullable: true items: $ref: '#/components/schemas/PassengerBag' infant: description: "The optional infant associated with this passenger.\n \ \ " nullable: true $ref: '#/components/schemas/PassengerInfant' travelDocuments: type: array description: "The collection of passenger travel Documents.\n \ \ " nullable: true items: $ref: '#/components/schemas/PassengerTravelDocument' addresses: type: array description: "The collection of passenger addresses.\n " nullable: true items: $ref: '#/components/schemas/PassengerAddress' weightCategory: description: "The weight category assigned to this passenger.\n \ \ " nullable: true $ref: '#/components/schemas/WeightCategory' emdCoupons: type: array description: "The passenger EMD coupons.\n " nullable: true items: $ref: '#/components/schemas/PassengerEmdCoupon' PassengerProgram: type: object description: "Model representing a passenger program.\n " additionalProperties: false properties: code: type: string description: "The program code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ nullable: true levelCode: type: string description: "The program level code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ nullable: true number: type: string description: "The program number.\n " maxLength: 32 minLength: 0 nullable: true PassengerInformation: type: object description: "Represents additional passenger information.\n " additionalProperties: false properties: nationality: type: string description: "The passenger's nationality.\n " maxLength: 2 minLength: 0 nullable: true residentCountry: type: string description: "The resident country.\n " maxLength: 2 minLength: 2 nullable: true gender: description: "The passenger's binary gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The passenger's date of birth.\n " format: date-time nullable: true familyNumber: type: integer description: "The unique identifier of a family registered in the system.\n\ \ " nullable: true declaredGender: type: string description: "The passenger's declared gender. A value of \"F\" is mapped\ \ to a female binary gender. All other values will be\nmapped to a male\ \ binary gender.\n " maxLength: 2 minLength: 0 nullable: true PassengerInfant: type: object description: "Model representing an infant with a passenger.\n " additionalProperties: false properties: nationality: type: string description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 nullable: true residentCountry: type: string description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 nullable: true dateOfBirth: type: string description: "The date of birth of the infant.\n " format: date-time nullable: true gender: description: "The gender of the passenger.\n " nullable: true $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " nullable: true $ref: '#/components/schemas/Name' declaredGender: type: string description: "The infant's declared gender. A value of \"F\" is mapped to\ \ a female binary gender. All other values will be\nmapped to a male binary\ \ gender.\n " maxLength: 2 minLength: 0 nullable: true fees: type: array description: "The collection of infant fees.\n " nullable: true items: $ref: '#/components/schemas/InfantFee' travelDocuments: type: array description: "Travel Documents.\n " nullable: true items: $ref: '#/components/schemas/PassengerTravelDocument' type: type: string description: "The infant passenger type.\n " nullable: true InfantFee: type: object description: "Defines the infant fee information.\n " additionalProperties: false required: - code properties: isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or\ \ not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n\ \ " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external\ \ or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: string description: "The fee detail.\n " maxLength: 32 minLength: 0 nullable: true passengerFeeKey: type: string description: "The passenger fee key.\n " nullable: true override: type: boolean description: "The fee override.\n " flightReference: type: string description: "The flight reference which signifies a link to a segment and\ \ or leg.\n " maxLength: 22 minLength: 0 nullable: true note: type: string description: "The fee notes.\n " maxLength: 128 minLength: 0 nullable: true createdDate: type: string description: "The created date for the fee.\n " format: date-time nullable: true isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: array description: "The list of service charges for the fee.\n " nullable: true items: $ref: '#/components/schemas/ServiceCharge' PassengerAddress: type: object description: "Passenger address information. This contains more data then the\ \ base address class.\n " additionalProperties: false properties: status: description: "The addresses APIS status.\n " $ref: '#/components/schemas/ApisAddressStatus' companyName: type: string description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 nullable: true phone: type: string description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 nullable: true stationCode: type: string description: "Station code associated with this address.\n " maxLength: 3 minLength: 3 nullable: true emailAddress: type: string description: "The email address associated with the address.\n \ \ " nullable: true cultureCode: type: string description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 nullable: true refusedContact: type: boolean description: "Indicates if the passenger refused to enter a contact.\n \ \ " nullable: true lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true passengerAddressKey: type: string description: "The unique address identifier.\n " nullable: true ApisAddressStatus: type: integer description: "Defines what type of APIS requirement is the address.\n \ \ \n\n0 = Residence\n1 = InCountry\n2 = Emergency\n3 = Contact" x-enumNames: - Residence - InCountry - Emergency - Contact enum: - 0 - 1 - 2 - 3 WeightCategory: type: integer description: "Defines the categories of adults by gender or specifies the passenger\ \ as a child. This is used for balance\ndeterminations.\n \n\n\ 0 = Undefined\n1 = Male\n2 = Female\n3 = Child" x-enumNames: - Undefined - Male - Female - Child enum: - 0 - 1 - 2 - 3 PassengerEmdCoupon: type: object description: "Model information for the passenger EMD coupon.\n " additionalProperties: false properties: status: description: "The EMD coupon status.\n " $ref: '#/components/schemas/EmdCouponStatus' emdTypeCode: description: "The EMD type code.\n " $ref: '#/components/schemas/EmdTypeCode' passengerEmdCouponKey: type: string description: "The unique identifier for a passenger EMD coupon.\n \ \ " nullable: true emdNumber: type: string description: "The 13 digit passenger EMD number, assigned after the EMD\ \ has been issued.\n " maxLength: 13 minLength: 0 nullable: true couponNumber: type: integer description: "The EMD coupon number, assigned after the EMD has been issued.\n\ TODO: In SkySpeed this is 0-4 only\n " maximum: 32767.0 minimum: 0.0 optionalServiceInformation: description: "The optional service information.\n " nullable: true $ref: '#/components/schemas/OptionalServiceInformation' salesDate: type: string description: "The sale date.\n " format: date-time nullable: true flightReference: type: string description: "The EMD flight reference.\n " maxLength: 22 minLength: 0 nullable: true receivedFromSystemCode: type: string description: "The received from system code.\n " maxLength: 3 minLength: 0 nullable: true numberOfServices: type: integer description: "The number of services.\n " maximum: 32767.0 minimum: 1.0 feeType: description: "The EMD related fee type.\n " $ref: '#/components/schemas/FeeType' feeKey: type: string description: "The EMD related fee key.\n " nullable: true ssrCode: type: string description: "The EMD related SSR code.\n " maxLength: 4 minLength: 0 nullable: true ssrNumber: type: integer description: "The EMD related SSR code.\n " nullable: true EmdCouponStatus: type: integer description: "Represents the EMD coupon status options.\n \n\n0 =\ \ Unknown\n1 = HeldConfirmed\n2 = HoldingNeed\n3 = HoldingConfirmedEmdRequired\n\ 4 = HoldingConfirmedEmdIssued" x-enumNames: - Unknown - HeldConfirmed - HoldingNeed - HoldingConfirmedEmdRequired - HoldingConfirmedEmdIssued enum: - 0 - 1 - 2 - 3 - 4 EmdTypeCode: type: integer description: "Represents the EMD type code options.\n \n\n0 = None\n\ 1 = Associated\n2 = StandAlone" x-enumNames: - None - Associated - StandAlone enum: - 0 - 1 - 2 OptionalServiceInformation: type: object description: "Represents the optional service information model.\n \ \ " additionalProperties: false properties: carrierCode: type: string description: "The optional service carrier code.\n " maxLength: 3 minLength: 0 nullable: true reasonForIssuanceSubCode: type: string description: "The optional service reason for issuance sub-code (RFISC).\n\ \ " maxLength: 3 minLength: 0 nullable: true Journey: type: object description: "Data about the journey which represents the collection of segments\ \ and their legs on the journey.\n " additionalProperties: false properties: journeyKey: type: string description: "The unique identifier for this journey sell information.\n\ \ " nullable: true notForGeneralUser: type: boolean description: "A value indicating whether the journey is for a general user.\n\ \ " flightType: description: "Returns a flight type enumeration. (NonStop, Thru, etc.)\n\ \ " $ref: '#/components/schemas/FlightType' stops: type: integer description: "The total number of stops this flight takes.\n " format: int32 designator: description: "This is a summary of all the segments. It will contain the\ \ details\nof the transportation from the first and last segment.\n \ \ " nullable: true $ref: '#/components/schemas/TransportationDesignator' move: description: "The information regarding the journey move restrictions.\n\ \ " nullable: true $ref: '#/components/schemas/JourneyMove' segments: type: array description: "The collection of segments.\n " nullable: true items: $ref: '#/components/schemas/Segment' FlightType: type: integer description: "Flight types enumeration.\n \n\n0 = None\n1 = NonStop\n\ 2 = Through\n3 = Direct\n4 = Connect\n5 = All" x-enumNames: - None - NonStop - Through - Direct - Connect - All enum: - 0 - 1 - 2 - 3 - 4 - 5 JourneyMove: type: object description: "Summarized move data at the journey level.\n " additionalProperties: false properties: maxMoveBackDays: type: integer description: "The maximum number of days this flight can be moved backwards.\n\ \ " format: int32 maxMoveOutDays: type: integer description: "The maximum number of days this flight can be moved forward.\n\ \ " format: int32 Segment: type: object description: "Segment model for an already booked flight.\n " additionalProperties: false properties: isStandby: type: boolean description: "Represents the stand by status of the segment.\n \ \ " isConfirming: type: boolean description: "Represents the confirming status of the segment.\n \ \ " isConfirmingExternal: type: boolean description: "Represents the pending external confirming status of the segment.\n\ \ " channelType: description: "The type of the channel from the user that added the segment.\n\ \ " $ref: '#/components/schemas/ChannelType' priorityCode: type: string description: "The priority code.\n " maxLength: 2 minLength: 0 nullable: true salesDate: type: string description: "The segment sales date.\n " format: date-time nullable: true flightReference: type: string description: "The flight reference which signifies a link to a segment and\ \ or leg.\n " maxLength: 22 minLength: 0 nullable: true status: description: "Represents the segment status.\n " $ref: '#/components/schemas/SegmentStatus' isBlocked: type: boolean description: "Represents the blocked status of the segment.\n \ \ " isHosted: type: boolean description: "Represents the hosted status of the segment.\n " isChangeOfGauge: type: boolean description: "Represents the change of gauge status of the segment.\n \ \ " designator: description: "This is a summary of all the legs on the segment. It will\ \ contain the details\nof the transportation from the first and last leg.\n\ \ " nullable: true $ref: '#/components/schemas/TransportationDesignator' segmentKey: type: string description: "The unique identifier for this segment sell information.\n\ \ " nullable: true cabinOfService: type: string description: "The cabin of service.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 nullable: true changeReasonCode: description: "The change reason code.\n " $ref: '#/components/schemas/ChangeReasonCodes' international: type: boolean description: "The value indicating if this segment is international.\n \ \ " legs: type: array description: "The legs.\n " nullable: true items: $ref: '#/components/schemas/Leg' isSeatmapViewable: type: boolean description: "Indicates if the seatmaps associated with the segment are\ \ retrievable.\nSets to `false` for passive segments, and `true` for non-passive\ \ segments.\n " identifier: description: "The transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' externalIdentifier: description: "The external transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' segmentType: description: "The type of the segment.\n " $ref: '#/components/schemas/SegmentTypes' fares: type: array description: "The fares.\n " nullable: true items: $ref: '#/components/schemas/Fare' passengerSegment: type: object description: "Passengers on this segment by passenger key.\n " nullable: true additionalProperties: $ref: '#/components/schemas/PassengerSegment' SegmentStatus: type: integer description: "The segment status.\n \n\n0 = UnknownStatus\n1 = UnableToConfirmSegment\n\ 2 = UnableToSellSegment\n3 = HeldPending\n4 = WaitListConfirmed\n5 = HeldUnconfirmed\n\ 6 = HeldConfirmed\n7 = HeldCancelled\n8 = Confirming\n9 = ConfirmingWaitList\n\ 10 = ConfirmedTimeChange" x-enumNames: - UnknownStatus - UnableToConfirmSegment - UnableToSellSegment - HeldPending - WaitListConfirmed - HeldUnconfirmed - HeldConfirmed - HeldCancelled - Confirming - ConfirmingWaitList - ConfirmedTimeChange enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 ChangeReasonCodes: type: integer description: "Specifies the reason code on why the change on the journey or\ \ segment is performed.\n \n\n0 = NoChange\n1 = Irop\n2 = ScheduleChange\n\ 3 = Move\n4 = VoluntaryFlyAhead\n5 = InvoluntaryFlyAhead\n6 = SelfServiceRebooking" x-enumNames: - NoChange - Irop - ScheduleChange - Move - VoluntaryFlyAhead - InvoluntaryFlyAhead - SelfServiceRebooking enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 Leg: type: object description: "Model data describing the leg which is a single travel leg from\ \ point a to b.\n " additionalProperties: false properties: legKey: type: string description: "The unique identifier for this leg sell information.\n \ \ " nullable: true designator: description: "Transportation information.\n " nullable: true $ref: '#/components/schemas/TransportationDesignator' operationsInfo: description: "The operations information.\n " nullable: true $ref: '#/components/schemas/OperationsInformation' legInfo: description: "The leg information.\n " nullable: true $ref: '#/components/schemas/LegInformation' nests: type: array description: "The collection of leg nests.\n " nullable: true items: $ref: '#/components/schemas/LegNest' ssrs: type: array description: "The Ssrs summary information.\n " nullable: true items: $ref: '#/components/schemas/LegSsr' seatmapReference: type: string description: "The reference identifying what seatmap the leg is in associated\ \ to.\n " nullable: true flightReference: type: string description: "The flight reference which signifies a link to a segment and\ \ or leg.\n " maxLength: 22 minLength: 0 nullable: true OperationsInformation: type: object description: "Model describing the operations information.\n " additionalProperties: false properties: arrivalGate: description: "The arrival gate information.\n " nullable: true $ref: '#/components/schemas/GateInformation' departureGate: description: "The departure gate information.\n " nullable: true $ref: '#/components/schemas/GateInformation' actualOffBlockTime: type: string description: "The actual off block time.\n " format: date-time nullable: true actualOnBlockTime: type: string description: "The actual on block time.\n " format: date-time nullable: true actualTouchDownTime: type: string description: "The actual touch down time.\n " format: date-time nullable: true airborneTime: type: string description: "The airborne time.\n " format: date-time nullable: true arrivalNote: type: string description: "The arrival note.\n " maxLength: 128 minLength: 0 nullable: true arrivalStatus: description: "The arrival status.\n " $ref: '#/components/schemas/ArrivalStatus' baggageClaim: type: string description: "The baggage claim.\n " maxLength: 10 minLength: 0 nullable: true departureNote: type: string description: "The departure note.\n " maxLength: 128 minLength: 0 nullable: true departureStatus: description: "The departure status.\n " $ref: '#/components/schemas/DepartureStatus' departureTimes: description: "The departure time information.\n " nullable: true $ref: '#/components/schemas/DepartureEvent' standardArrivalTime: type: string description: "The standard time of arrival (STA).\n " format: date-time nullable: true tailNumber: type: string description: "The tail number.\n " maxLength: 10 minLength: 0 nullable: true estimatedArrivalTime: type: string description: "The estimated time of arrival (ETA).\n " format: date-time nullable: true GateInformation: type: object description: "Represents the gate information for the trip status model. Consists\n\ of actual gate information and estimated/scheduled gate information.\n \ \ " additionalProperties: false properties: estimatedGate: type: string description: "Represents the estimated or scheduled gate of the trip mode.\n\ \ " maxLength: 4 minLength: 0 nullable: true actualGate: type: string description: "Represents the actual gate of the trip mode.\n " maxLength: 4 minLength: 0 nullable: true ArrivalStatus: type: integer description: "Arrival status.\n \n\n0 = Default\n1 = Cancelled\n\ 2 = Arrived\n3 = SeeAgent\n4 = Delayed" x-enumNames: - Default - Cancelled - Arrived - SeeAgent - Delayed enum: - 0 - 1 - 2 - 3 - 4 DepartureStatus: type: integer description: "Departure status.\n \n\n0 = Default\n1 = Cancelled\n\ 2 = Boarding\n3 = SeeAgent\n4 = Delayed\n5 = Departed" x-enumNames: - Default - Cancelled - Boarding - SeeAgent - Delayed - Departed enum: - 0 - 1 - 2 - 3 - 4 - 5 DepartureEvent: type: object description: "Represents the flight operation times for the departure event,\ \ which\nincludes an estimated and scheduled time event.\n " additionalProperties: false properties: scheduled: type: string description: "Represents the scheduled departure time.\n " format: date-time nullable: true estimated: type: string description: "Represents the estimated departure time.\n " format: date-time nullable: true LegInformation: type: object description: "Model describing the detailed leg information.\n " additionalProperties: false properties: departureTimeUtc: type: string description: "The departure time using the time variant in universal time.\n\ \ " format: date-time nullable: true arrivalTimeUtc: type: string description: "The arrival time using the time variant in universal time.\n\ \ " format: date-time nullable: true adjustedCapacity: type: integer description: "The leg adjusted capacity.\n " arrivalTerminal: type: string description: "The leg arrival terminal.\n " maxLength: 2 minLength: 0 nullable: true arrivalTimeVariant: type: integer description: "The leg arrival Local Time Variant (LTV).\n " backMoveDays: type: integer description: "The legs back move days.\n " capacity: type: integer description: "The leg capacity.\n " changeOfDirection: type: boolean description: "A value indicating whether the leg has a change of direction.\n\ \ " codeShareIndicator: description: "The leg code share indicator.\n " $ref: '#/components/schemas/CodeShareIndicator' departureTerminal: type: string description: "The leg departure terminal.\n " maxLength: 2 minLength: 0 nullable: true departureTimeVariant: type: integer description: "The leg departure Local Time Variant (LTV).\n " equipmentType: type: string description: "The leg type of the equipment.\n " maxLength: 3 minLength: 0 nullable: true equipmentTypeSuffix: type: string description: "The leg equipment type suffix.\n " maxLength: 3 minLength: 0 nullable: true eTicket: type: boolean description: "A value indicating whether this leg is an e-ticketed leg.\n\ \ " irop: type: boolean description: "Gets or sets a value indicating whether this leg is an IROP.\n\ \ " lid: type: integer description: "The legs lid.\n " marketingCode: type: string description: "The leg marketing code.\n " nullable: true marketingOverride: type: boolean description: "A value indicating whether the leg has a marketing override.\n\ \ " operatedByText: type: string description: "The leg \"operated by\" text.\n " nullable: true operatingCarrier: type: string description: "The leg operating carrier.\n " nullable: true operatingFlightNumber: type: string description: "The leg operating flight number.\n " nullable: true operatingOpSuffix: type: string description: "The leg operating operating suffix.\nPlease note that this\ \ should be a char and not a string.\n " maxLength: 1 nullable: true outMoveDays: type: integer description: "The leg move out days.\n " arrivalTime: type: string description: "The leg passenger standard time of arrival (STA).\n \ \ " format: date-time nullable: true departureTime: type: string description: "The leg passenger standard time of departure (STD).\n \ \ " format: date-time nullable: true prbcCode: type: string description: "The leg PRBC code.\n " maxLength: 8 minLength: 0 nullable: true scheduleServiceType: type: string description: "The type of the schedule service.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 nullable: true sold: type: integer description: "The sold.\n " status: description: "The legs status.\n " $ref: '#/components/schemas/LegStatus' subjectToGovtApproval: type: boolean description: "A value indicating whether the leg is subject to government\ \ approval.\n " LegNest: type: object description: "A model representing a leg nest.\n " additionalProperties: false properties: adjustedCapacity: type: integer description: "Gets or sets the adjusted capacity of the nest.\n \ \ " classNest: type: integer description: "Gets or sets the nest class nest.\n " lid: type: integer description: "Gets or sets the nest lid.\n " travelClassCode: type: string description: "Gets or sets the nest travel class code.\nPlease note that\ \ this should be a char and not a string.\n " maxLength: 1 nullable: true nestType: description: "Gets or sets the type of the nest.\n " $ref: '#/components/schemas/NestType' legClasses: type: array description: "Gets or sets the nest leg classes.\n " nullable: true items: $ref: '#/components/schemas/LegClass' LegClass: type: object description: "The leg class model information.\n " additionalProperties: false required: - classOfService properties: classAllotted: type: integer description: "The leg class allotted.\n " classAuthorizedUnits: type: integer description: "The leg class Authorized Units (AUs).\n " classOfService: type: string description: "The leg class, class of service.\n " maxLength: 8 minLength: 0 classRank: type: integer description: "The leg class rank.\n " classSold: type: integer description: "The class sold.\n " cnxSold: type: integer description: "The CNX sold.\n " latestAdvancedReservation: type: integer description: "The latest advanced reservation.\n " status: description: "The status.\n " $ref: '#/components/schemas/ClassStatus' thruSold: type: integer description: "The thru sold.\n " classNest: type: integer description: "The leg class nest.\n " classType: type: string description: "The type of class.\n " nullable: true Fare: type: object description: "Model describing a fare.\n " additionalProperties: false properties: carrierCode: type: string description: "The fares carrier code.\n " maxLength: 3 minLength: 2 nullable: true classOfService: type: string description: "The class of service.\n " maxLength: 8 minLength: 0 nullable: true fareApplicationType: description: "The type of the fare application.\n " $ref: '#/components/schemas/FareApplicationType' fareBasisCode: type: string description: "The fare basis code.\n " maxLength: 8 minLength: 0 nullable: true inboundOutBound: description: "The inbound and outbound.\n " $ref: '#/components/schemas/InboundOutbound' isAllotmentMarketFare: type: boolean description: "Gets or sets a value indicating whether this fare is an allotment\ \ marker.\n " ruleNumber: type: string description: "The rule number.\n " maxLength: 4 minLength: 0 nullable: true ruleTariff: type: string description: "The rule tariff.\n " maxLength: 4 minLength: 0 nullable: true pricingDate: type: string description: "The pricing date.\n " format: date-time fareDesignator: description: "The fare designator.\n " nullable: true $ref: '#/components/schemas/FareDesignator' isGoverning: type: boolean description: "Flag that indicates if the fare is the governing fare.\n \ \ " fareKey: type: string description: "Unique key for this type of fare.\n " nullable: true classType: type: string description: "The fares type of the class.\n " nullable: true fareClassOfService: type: string description: "The fare class of service.\n " maxLength: 8 minLength: 0 nullable: true fareSequence: type: integer description: "The fare sequence.\n " maximum: 32767.0 minimum: 0.0 fareStatus: description: "The fare status.\n " $ref: '#/components/schemas/FareStatus' originalClassOfService: type: string description: "The original class of service.\n " maxLength: 8 minLength: 0 nullable: true productClass: type: string description: "The product class.\n " maxLength: 2 minLength: 0 nullable: true travelClassCode: type: string description: "The travel class code.\nPlease note that this should be a\ \ char and not a string.\n " maxLength: 1 nullable: true crossReferenceClassOfService: type: string description: "The cross reference class of service.\n " maxLength: 8 minLength: 0 nullable: true passengerFares: type: array description: "The collection of passenger fares.\n " nullable: true items: $ref: '#/components/schemas/PassengerFare' fareLink: type: integer description: "The fare link.\n " maximum: 32767.0 minimum: 0.0 FareApplicationType: type: integer description: "This enumeration defines the fare application type of a fare.\n\ \ \n\n0 = Route\n1 = Sector\n2 = Governing" x-enumNames: - Route - Sector - Governing enum: - 0 - 1 - 2 InboundOutbound: type: integer description: "This enumeration specifies direction of flight application.\n\ \ \n\n0 = None\n1 = Inbound\n2 = Outbound\n3 = Both\n4 = RoundFrom\n\ 5 = RoundTo" x-enumNames: - None - Inbound - Outbound - Both - RoundFrom - RoundTo enum: - 0 - 1 - 2 - 3 - 4 - 5 FareDesignator: type: object description: "Model describing the fare designator information.\n \ \ " additionalProperties: false properties: fareTypeCodes: type: array description: "The fares carrier code.\n " nullable: true items: type: string FareStatus: type: integer description: "This enumeration defines the fare status of a passenger fare.\n\ \ \n\n0 = Default\n1 = SameDayStandBy\n2 = FareOverrideConfirming\n\ 3 = FareOverrideConfirmed\n4 = PublishedFareOverrideConfirming\n5 = PublishedFareOverrideConfirmed" x-enumNames: - Default - SameDayStandBy - FareOverrideConfirming - FareOverrideConfirmed - PublishedFareOverrideConfirming - PublishedFareOverrideConfirmed enum: - 0 - 1 - 2 - 3 - 4 - 5 PassengerFare: type: object description: "Model that represents the passenger fare details.\n \ \ " additionalProperties: false required: - passengerType properties: fareDiscountCode: type: string description: "The fare discount code.\n " maxLength: 8 minLength: 0 nullable: true passengerType: type: string description: "The type of the passenger.\n " maxLength: 4 minLength: 0 serviceCharges: type: array description: "The service charges.\n " nullable: true items: $ref: '#/components/schemas/ServiceCharge' discountCode: type: string description: "The passenger discount code.\n " maxLength: 4 minLength: 0 nullable: true ticketFareBasis: type: string description: "A fare basis alias which is a more descriptive and custom\ \ value than the fare basis itself. \nThis value is created in FareManager\ \ Plus based on specific fare rule categories and ATPCO documentation.\n\ \ " nullable: true PassengerSegment: type: object description: "Model data for the passenger on the booking for the specific segment.\n\ \ " additionalProperties: false properties: seats: type: array description: "The seat details.\n " nullable: true items: $ref: '#/components/schemas/PassengerSeat' passengerKey: type: string description: "The unique key of the passenger on the segment\n \ \ " nullable: true activityDate: type: string description: "The activity date.\n " format: date-time nullable: true boardingSequence: type: string description: "The passenger segment boarding sequence.\n " nullable: true createdDate: type: string description: "The created date.\n " format: date-time nullable: true liftStatus: description: "The lift status.\n " $ref: '#/components/schemas/LiftStatus' modifiedDate: type: string description: "The modified date.\n " format: date-time nullable: true overBookIndicator: description: "The over book indicator.\n " $ref: '#/components/schemas/OverbookIndicatorTypes' priorityDate: type: string description: "The priority date.\n " format: date-time nullable: true timeChanged: type: boolean description: "Gets or sets a value indicating whether the passenger segment\ \ time has changed.\n " verifiedTravelDocs: type: string description: "The verified travel docs. Please use VerifiedTravelDocuments\ \ instead.\n " maxLength: 44 minLength: 0 nullable: true sourcePointOfSale: description: "The source point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' pointOfSale: description: "The point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' ssrs: type: array description: "The Ssr information for both the leg and segment.\n \ \ " nullable: true items: $ref: '#/components/schemas/PassengerSsr' tickets: type: array description: "The ticket information.\n " nullable: true items: $ref: '#/components/schemas/Ticket' bags: type: array description: "The baggage information.\n " nullable: true items: $ref: '#/components/schemas/PassengerSegmentBag' scores: type: array description: "The collection of passenger scores.\n " nullable: true items: $ref: '#/components/schemas/PassengerScore' boardingPassDetail: description: "The passengers boarding pass details.\n " nullable: true $ref: '#/components/schemas/PassengerBoardingPassDetail' hasInfant: type: boolean description: "Flag indicating if the passenger has an infant for the specific\ \ segment.\n " seatPreferences: description: "The passenger seat preferences.\n " nullable: true $ref: '#/components/schemas/SeatPreferences' bundleCode: type: string description: "The bundle code associated with the passenger segment.\n \ \ " nullable: true verifiedTravelDocuments: type: array description: "The travel document keys that have been verified at checkin.\n\ \ " nullable: true items: type: string referenceNumber: type: integer description: "The reference number, used as an identifier by New Skies Rail\ \ customers for purposes\nof ticketing and check in.\n " format: int64 baggageGroupNumber: type: integer description: "The passenger's baggage group number.\n " nullable: true baggageAllowanceUsed: type: boolean description: "Indicates whether the passenger segment baggage allowance\ \ is used.\n " baggageAllowanceWeight: type: integer description: "The passenger segment baggage allowance weight.\n \ \ " maximum: 32767.0 minimum: 0.0 baggageAllowanceWeightType: description: "The type of passenger segment baggage allowance weight.\n\ \ " $ref: '#/components/schemas/WeightType' stayType: description: "The stay type.\n " $ref: '#/components/schemas/GssStayType' infantStayType: description: "The stay type for an infant.\n " $ref: '#/components/schemas/GssStayType' PassengerSeat: type: object description: "Model for a passenger seat for a segment.\n " additionalProperties: false properties: compartmentDesignator: type: string description: "The passenger seat compartment designator.\n " maxLength: 2 minLength: 0 nullable: true penalty: type: integer description: "The passenger seat penalty.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 unitDesignator: type: string description: "The passenger seat unit designator.\n " nullable: true seatInformation: description: "The passenger seat seat information.\n " nullable: true $ref: '#/components/schemas/SeatInfo' arrivalStation: type: string description: "The leg arrival station.\n " maxLength: 3 minLength: 3 nullable: true departureStation: type: string description: "The leg departure station.\n " maxLength: 3 minLength: 3 nullable: true passengerKey: type: string description: "The passenger key associated with the seat.\n " nullable: true unitKey: type: string description: "The seat's unique unit key.\n " nullable: true crossReferenceSeatingPreference: type: string description: "The seating preference for non-hosted flight seating assignments.\n\ Could be either one of the following values:\nnull = seating preference\ \ is not applicable (usual value for hosted flights)\nN = no requested\ \ seating preference\nA = aisle\nW = window\nF = front seating location\n\ R = rear seating location\nAF = front seating location, on aisle\nAR =\ \ rear seating location, on aisle\nWF = front seating location, on window\n\ WR = rear seating location, on window\n " nullable: true isPending: type: boolean description: "Determines whether or not the seat is pending request.\n \ \ " seatmapReference: type: string description: "The reference identifying what seat map the passenger seat\ \ is associated to.\n " nullable: true SeatInfo: type: object description: "The model for the seat information such as deck, seat properties,\ \ etc.\n " additionalProperties: false properties: deck: type: integer description: "Gets or sets the deck.\n " seatSet: type: integer description: "Gets or sets the seat set.\n " propertyList: type: object description: "The property list by type code and value.\n " nullable: true additionalProperties: type: string OverbookIndicatorTypes: type: integer description: "Specifies the type of code share agreement.\n \n\n\ 0 = NormalSell\n1 = Oversold\n2 = ClassOrCabinOversold" x-enumNames: - NormalSell - Oversold - ClassOrCabinOversold enum: - 0 - 1 - 2 PassengerSsr: type: object description: "The model for a passengers Ssr details.\n " additionalProperties: false properties: note: type: string description: "The passenger SSR note.\n " maxLength: 128 minLength: 0 nullable: true count: type: integer description: "The passenger SSR unit value.\n " maximum: 32767.0 minimum: 1.0 inBundle: type: boolean description: "Indicates if the SSR is part of a bundle.\n " ssrDuration: description: "The length of the Ssr duration.\n " $ref: '#/components/schemas/SsrDurationType' ssrCode: type: string description: "The passenger SSR code.\n " maxLength: 4 minLength: 0 nullable: true passengerKey: type: string description: "The unique passenger key.\n " nullable: true ssrNumber: type: integer description: "The passenger SSR number.\n " maximum: 32767.0 minimum: 0.0 nullable: true market: description: "The market for either the leg or segment depending on the\ \ Ssr type.\n " nullable: true $ref: '#/components/schemas/MarketInformation' isConfirmed: type: boolean description: "A status flag to indicate if the ssr has been confirmed or\ \ not.\n " isConfirmingUnheld: type: boolean description: "A status flag to indicate if the ssr is in a confirming unheld\ \ state.\n " ssrKey: type: string description: "The key that uniquely identifies the Ssr, passenger, and leg\ \ or segment.\n " nullable: true feeCode: type: string description: "The SSR fee code.\n " maxLength: 6 minLength: 0 nullable: true ssrDetail: type: string description: "The passenger SSR detail.\n " maxLength: 20 minLength: 0 nullable: true SsrDurationType: type: integer description: "Ssr duration type.\n \n\n0 = Segment\n1 = Journey\n\ 2 = Leg" x-enumNames: - Segment - Journey - Leg enum: - 0 - 1 - 2 Ticket: type: object description: "Model for a ticket applied to a passenger.\n " additionalProperties: false properties: ticketNumber: type: string description: "The ticket number.\n " maxLength: 14 minLength: 0 nullable: true infantTicketNumber: type: string description: "The infant ticket number.\n " maxLength: 14 minLength: 0 nullable: true ticketIndicator: description: "The ticket indicator.\n " $ref: '#/components/schemas/TicketIndicatorCode' ticketStatus: description: "The ticket status.\n " $ref: '#/components/schemas/TicketStatusCode' passengerKey: type: string description: "The passenger key the ticket is associated with.\n \ \ " nullable: true TicketIndicatorCode: type: integer description: "This enumeration defines the ticket requirements\n \ \ \n\n0 = Unknown\n1 = TicketRequired\n2 = AutomatedTicketLiftRequired\n3\ \ = ManualTicketLiftRequired\n4 = AutomatedTicketNoLiftRequired\n5 = ManualTicketNoLiftRequired\n\ 6 = HostETicketNoLiftRequired\n7 = ElectronicTicketNoLiftRequired" x-enumNames: - Unknown - TicketRequired - AutomatedTicketLiftRequired - ManualTicketLiftRequired - AutomatedTicketNoLiftRequired - ManualTicketNoLiftRequired - HostETicketNoLiftRequired - ElectronicTicketNoLiftRequired enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 TicketStatusCode: type: integer description: "This enumeration defines the ticket availability status.\n \ \ \n\n0 = Unknown\n1 = TicketAvailableForUse\n2 = TicketUnavailableForUse\n\ 3 = TicketReissueRequiredForPassenger\n4 = TicketReissueRequiredForInfant\n\ 5 = TicketReissueRequiredForBoth\n6 = TicketReValidationRequired" x-enumNames: - Unknown - TicketAvailableForUse - TicketUnavailableForUse - TicketReissueRequiredForPassenger - TicketReissueRequiredForInfant - TicketReissueRequiredForBoth - TicketReValidationRequired enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 PassengerSegmentBag: type: object description: "Model information about the baggage a passenger has on a segment.\n\ \ " additionalProperties: false required: - passengerKey - arrivalStation - departureStation properties: baggageKey: type: string description: "Unique key for the baggage.\n " nullable: true passengerKey: type: string description: "The passenger key associated to this bag.\n " minLength: 1 arrivalStation: type: string description: "The bag segment arrival station.\n " maxLength: 3 minLength: 3 status: description: "The bag status.\n " $ref: '#/components/schemas/BaggageStatus' departureStation: type: string description: "The bag segment departure station.\n " maxLength: 3 minLength: 3 osTag: type: string description: "The bag OS tag.\n " maxLength: 32 minLength: 0 nullable: true PassengerScore: type: object description: "Defines a passenger score.\n " additionalProperties: false required: - guestValueCode properties: guestValueCode: type: string description: "The guest value code.\n " maxLength: 8 minLength: 1 score: type: integer description: "The score.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 passengerKey: type: string description: "The passenger key associated with the score.\n " nullable: true PassengerBoardingPassDetail: type: object description: "Defines information used to populate the printed boarding pass\ \ and 2D bar codes.\n " additionalProperties: false properties: gateInformation: type: string description: "The gate information from the boarding pass.\n " nullable: true priorityInformation: type: string description: "The priority information from the boarding pass.\n \ \ " nullable: true cabinClass: type: string description: "The cabin class as seen from the boarding pass.\n \ \ " nullable: true compartmentLevel: type: string description: "The compartment level as seen from the boarding pass.\n \ \ " nullable: true boardingZone: type: string description: "The assigned boarding zone from the boarding pass.\n \ \ " nullable: true seatAssignment: type: string description: "The seat assignment as seen from the boarding pass.\n \ \ " nullable: true sequenceNumber: type: string description: "The boarding sequence number as seen from the boarding pass.\n\ \ " nullable: true SeatPreferences: type: object description: "Represents the seating preferences base model.\n " additionalProperties: false properties: seat: description: "The simple seating preference.\n " nullable: true $ref: '#/components/schemas/SimpleSeatPreference' travelClass: description: "The preferred travel class of service.\n " nullable: true $ref: '#/components/schemas/TravelClassSeatPreference' advancedPreferences: type: array description: "The advanced seating preferences.\n " nullable: true items: $ref: '#/components/schemas/SeatPreference' SimpleSeatPreference: type: integer description: "Represents a simple seating preference.\n \n\n0 = None\n\ 1 = Window\n2 = Aisle\n3 = Other" x-enumNames: - None - Window - Aisle - Other enum: - 0 - 1 - 2 - 3 TravelClassSeatPreference: type: integer description: "Represents a travel class seating preference.\n \n\n\ 0 = None\n1 = Business\n2 = Economy\n3 = FirstClass" x-enumNames: - None - Business - Economy - FirstClass enum: - 0 - 1 - 2 - 3 SeatPreference: type: object description: "Represents a single seat preference.\n " additionalProperties: false required: - seatMapCode - value properties: seatMapCode: type: string description: "The seat map code (ex. 'SMOKING').\n " maxLength: 8 minLength: 0 value: type: string description: "The seat map value (ex. 'TRUE').\n " maxLength: 8 minLength: 0 status: description: "Defines if the seat preference is met, not met or unknown.\n\ \ " $ref: '#/components/schemas/SeatPreferenceStatus' SeatPreferenceStatus: type: integer description: "Defines the seat preference status.\n \n\n0 = Unknown\n\ 1 = Met\n2 = NotMet" x-enumNames: - Unknown - Met - NotMet enum: - 0 - 1 - 2 GssStayType: type: integer description: "The type of stay type.\n \n\n0 = None\n1 = Vacation\n\ 2 = Business\n3 = Duty" x-enumNames: - None - Vacation - Business - Duty enum: - 0 - 1 - 2 - 3 BookingQueueInfo: type: object description: "Describes the booking queue info.\n " additionalProperties: false properties: code: type: string description: "The identifier for the queue where the booking is placed.\n\ \ " maxLength: 6 minLength: 0 nullable: true subCode: type: string description: "The identifier for the sub queue where the booking is placed.\n\ \ " maxLength: 6 minLength: 0 nullable: true name: type: string description: "The name for the queue where the booking is placed.\n \ \ " maxLength: 64 minLength: 0 nullable: true queueId: type: integer description: "The unique ID of the booking queue entry.\n " format: int64 passengerId: type: integer description: "The unique identifier of a passenger on the booking.\n \ \ " format: int64 watchListId: type: integer description: "Unique identifier of the watchlist where a match was found\ \ for the booking or passenger.\n " format: int64 note: type: string description: "A summary on why the booking was placed in the queue.\n \ \ " maxLength: 128 minLength: 0 nullable: true type: description: "The type of event that triggered placement of the booking\ \ in the queue.\n " $ref: '#/components/schemas/QueueEventType' action: description: "The action that will be taken as a result of the placement\ \ in the queue.\n " $ref: '#/components/schemas/QueueAction' mode: description: "The indicator if this entry was added or removed from the\ \ queue.\n " $ref: '#/components/schemas/QueueMode' flightReference: type: string description: "The flight reference.\n " nullable: true bookingQueueKey: type: string description: "The key of the booking queue entry.\n " nullable: true passengerAlternateKey: type: string description: "The unique identifier of a passenger on the booking.\n \ \ " nullable: true watchListKey: type: string description: "Unique identifier of the watchlist where a match was found\ \ for the booking or passenger.\n " nullable: true QueueEventType: type: integer description: "Describes the different queue event types.\n \n\n0\ \ = Default\n1 = BookingBalanceDue\n2 = BookingNegativeBalance\n3 = BookingCustomerComment\n\ 4 = DeclinedPaymentInitial\n5 = DeclinedPaymentChange\n6 = FareOverride\n\ 7 = ScheduleTimeChange\n8 = ScheduleTimeChangeMisconnect\n9 = ScheduleCancellation\n\ 10 = FlightDesignatorChange\n11 = ReaccommodationMove\n12 = GdsCancelWithPendingPayment\n\ 13 = InvalidPriceStatusOverride\n14 = FareRestrictionOverride\n15 = HeldBookings\n\ 16 = InvalidPriceStatus\n17 = Watchlist\n18 = NonFlightServiceFee\n19 = NotAllTicketNumbersReceived\n\ 20 = BookingSegmentOversold\n21 = ReaccommodationCancel\n22 = ExternalSsrAutoConfirmed\n\ 23 = OpCarrierSegUpdate\n24 = OpCarrierSsrUpdate\n25 = OpCarrierOtherUpdate\n\ 26 = NameChangeNotAllowed\n27 = InboundAscNotProcessed\n28 = OpCarrierInformationChange\n\ 29 = BookingComponentUpdate\n30 = GroupBookings\n31 = BankDirectPnrOutOfBalance\n\ 32 = NoSeatAssigned\n33 = SeatNumberChange\n34 = SsrNotSupportedOnNewSeat\n\ 35 = FewerSeatPreferencesMetOnNewSeat\n36 = AosUnableToConfirmCancel\n37 =\ \ ETicketIssue\n38 = ETicketFollowup\n39 = InvoluntaryFlyAhead\n40 = ManualClearanceOnOutage\n\ 41 = UnbalancedPoints\n42 = OpCarrierTimeChange\n43 = OaCarrierTimeChange\n\ 44 = VoluntaryFlightChange\n45 = InvoluntaryFlightChange\n46 = HoldCancellationFailed\n\ 47 = ScheduleTimeChangeWithDynamicQueueCode\n48 = ReaccommodationMoveWithDynamicQueueCode\n\ 49 = ItineraryIntegrity\n50 = ReducePartyNotProcessed\n51 = CheckedPassengerUpdate\n\ 52 = MustBeSeatGroupViolation\n57 = NameChangeWithinRule\n58 = IncompletePassengerEMDCoupon\n\ 59 = ASVCUpdateFailed\n60 = FailedFareClassRealignment\n61 = ScheduleTimeChangeMisconnectBelowMinimum\n\ 62 = ScheduleTimeChangeMisconnectAboveMaximum\n63 = OpCarrierMisconnect\n\ 64 = InventoryQueuing\n65 = SelfServiceAsm\n66 = SelfServiceDelay\n67 = SelfServiceFlightCancellation\n\ 68 = SelfServiceIrop\n69 = SelfServiceScheduleChange\n70 = SelfServiceTimeChange\n\ 71 = AosAddOrCancelNotSuccessful\n72 = MissingGdsFareFamily\n73 = ChangeCabinQueue\n\ 74 = PendingPaymentQueue\n75 = TicketDisplayToDetermineIncludedServiceBundleFailed\n\ 76 = DuplicateTicketsInBooking\n77 = TicketCouponUpdateQueue\n78 = ETicketRefund\n\ 79 = ExternalEticketVoidCheck\n80 = ExternalEticketVoidCheckFollowUp\n81 =\ \ NoAssignedSeatOnNewFlightFromEquipmentChange" x-enumNames: - Default - BookingBalanceDue - BookingNegativeBalance - BookingCustomerComment - DeclinedPaymentInitial - DeclinedPaymentChange - FareOverride - ScheduleTimeChange - ScheduleTimeChangeMisconnect - ScheduleCancellation - FlightDesignatorChange - ReaccommodationMove - GdsCancelWithPendingPayment - InvalidPriceStatusOverride - FareRestrictionOverride - HeldBookings - InvalidPriceStatus - Watchlist - NonFlightServiceFee - NotAllTicketNumbersReceived - BookingSegmentOversold - ReaccommodationCancel - ExternalSsrAutoConfirmed - OpCarrierSegUpdate - OpCarrierSsrUpdate - OpCarrierOtherUpdate - NameChangeNotAllowed - InboundAscNotProcessed - OpCarrierInformationChange - BookingComponentUpdate - GroupBookings - BankDirectPnrOutOfBalance - NoSeatAssigned - SeatNumberChange - SsrNotSupportedOnNewSeat - FewerSeatPreferencesMetOnNewSeat - AosUnableToConfirmCancel - ETicketIssue - ETicketFollowup - InvoluntaryFlyAhead - ManualClearanceOnOutage - UnbalancedPoints - OpCarrierTimeChange - OaCarrierTimeChange - VoluntaryFlightChange - InvoluntaryFlightChange - HoldCancellationFailed - ScheduleTimeChangeWithDynamicQueueCode - ReaccommodationMoveWithDynamicQueueCode - ItineraryIntegrity - ReducePartyNotProcessed - CheckedPassengerUpdate - MustBeSeatGroupViolation - NameChangeWithinRule - IncompletePassengerEMDCoupon - ASVCUpdateFailed - FailedFareClassRealignment - ScheduleTimeChangeMisconnectBelowMinimum - ScheduleTimeChangeMisconnectAboveMaximum - OpCarrierMisconnect - InventoryQueuing - SelfServiceAsm - SelfServiceDelay - SelfServiceFlightCancellation - SelfServiceIrop - SelfServiceScheduleChange - SelfServiceTimeChange - AosAddOrCancelNotSuccessful - MissingGdsFareFamily - ChangeCabinQueue - PendingPaymentQueue - TicketDisplayToDetermineIncludedServiceBundleFailed - DuplicateTicketsInBooking - TicketCouponUpdateQueue - ETicketRefund - ExternalEticketVoidCheck - ExternalEticketVoidCheckFollowUp - NoAssignedSeatOnNewFlightFromEquipmentChange 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 - 52 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 QueueAction: type: integer description: "Specifies the basics by which a queue filter was created.\n \ \ \n\n0 = Default\n1 = Warning\n2 = Lock\n3 = DefaultAndNotify\n\ 4 = WarningAndNotify\n5 = LockAndNotify" x-enumNames: - Default - Warning - Lock - DefaultAndNotify - WarningAndNotify - LockAndNotify enum: - 0 - 1 - 2 - 3 - 4 - 5 QueueMode: type: integer description: "Determines where a queue request is coming from.\n \ \ \n\n0 = EnQueued\n1 = DeQueued" x-enumNames: - EnQueued - DeQueued enum: - 0 - 1 BookingHistory: type: object description: "Defines a booking history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' receivedBy: type: string description: "The received by name.\n " maxLength: 64 minLength: 0 nullable: true receivedByReference: type: string description: "The received by reference number.\n " maxLength: 20 minLength: 0 nullable: true createdDate: type: string description: "The the history entry was created.\n " format: date-time nullable: true historyCategory: description: "The booking history report category.\n " $ref: '#/components/schemas/HistoryCategory' details: type: string description: "The the history report data.\n " nullable: true event: description: "The specific history code.\n " $ref: '#/components/schemas/BookingHistoryEvent' HistoryCategory: type: integer description: "Represents the various history report types.\n \n\n\ 0 = Unknown\n1 = Baggage\n2 = BagTagPrint\n3 = BoardingPassPrint\n4 = CheckIn\n\ 5 = ClassOfServiceChange\n6 = Comment\n7 = ConfirmedSegment\n8 = ContactChange\n\ 9 = Converted\n10 = CouponOverride\n11 = DividePnr\n12 = FareOverride\n13\ \ = Fee\n14 = FlightMove\n15 = GroupNameChange\n16 = Hold\n17 = ItinerarySent\n\ 18 = ManualPayment\n19 = MoveBackPnr\n20 = NameChange\n21 = NameRemove\n22\ \ = Payment\n23 = Pds\n24 = Promotion\n25 = QueuePlaceRemove\n26 = RecordLocator\n\ 27 = ScheduleCancelllation\n28 = ScheduleCodeShareChange\n29 = ScheduleFlightDesignatorChange\n\ 30 = ScheduleTimeChange\n31 = SeatAssignment\n32 = SegmentChange\n33 = Reprice\n\ 34 = SsrChange\n35 = StandByChange\n36 = TicketNumber\n37 = VerifiedTravelDocument\n\ 38 = Apps\n39 = InhibitedOverride\n40 = CustomIdChange\n41 = HoldDateChange\n\ 42 = AddedTravelDocument\n43 = ChangedTravelDocument\n44 = ChangedPayment" x-enumNames: - Unknown - Baggage - BagTagPrint - BoardingPassPrint - CheckIn - ClassOfServiceChange - Comment - ConfirmedSegment - ContactChange - Converted - CouponOverride - DividePnr - FareOverride - Fee - FlightMove - GroupNameChange - Hold - ItinerarySent - ManualPayment - MoveBackPnr - NameChange - NameRemove - Payment - Pds - Promotion - QueuePlaceRemove - RecordLocator - ScheduleCancelllation - ScheduleCodeShareChange - ScheduleFlightDesignatorChange - ScheduleTimeChange - SeatAssignment - SegmentChange - Reprice - SsrChange - StandByChange - TicketNumber - VerifiedTravelDocument - Apps - InhibitedOverride - CustomIdChange - HoldDateChange - AddedTravelDocument - ChangedTravelDocument - ChangedPayment 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 BookingHistoryEvent: type: integer description: "Represents the different events that trigger an\nentry into the\ \ schedule history.\n \n\n0 = Unknown\n1 = ConvertedHistory\n2\ \ = FlightTimeChange\n3 = FlightDesignatorChange\n4 = AssignedSeat\n5 = RemoveSeat\n\ 6 = AddedFlight\n7 = DeletedFlight\n8 = DeletedPassenger\n9 = NameChange\n\ 10 = GroupNameChange\n11 = CancelledTicketing\n12 = ScheduleChange\n13 = AddedPayment\n\ 14 = ServiceFee\n15 = QueuedPnr\n16 = UnqueuedPnr\n17 = DeletedComment\n18\ \ = Divided\n19 = CheckedIn\n20 = CheckedOut\n21 = FareOverride\n22 = AddedBaggage\n\ 23 = ChangedBaggageWeight\n24 = CheckedBaggage\n25 = RemovedBaggage\n26 =\ \ BoardedPassenger\n27 = UnboardedPassenger\n28 = ManualAuthorization\n29\ \ = ManualDecline\n30 = UndoCancel\n31 = ItinerarySent\n32 = ContactChange\n\ 33 = SsrAdded\n34 = FlightMoved\n35 = VerifiedDocument\n36 = RemovedVerifiedDocument\n\ 37 = Promotion\n38 = BookingComment\n39 = CancelledSchedule\n40 = CancelServiceFee\n\ 41 = OverrideServiceFee\n42 = AddedRecordLocator\n43 = DeletedRecordLocator\n\ 44 = UpgradeClassOfService\n45 = DowngradeClassOfService\n46 = StandbyPriorityChange\n\ 47 = AssignedTicketNumber\n48 = DeletedTicketNumber\n49 = ConfirmSegmentStatusCodeChange\n\ 50 = CodeshareFlightChanged\n51 = PdsCancel\n52 = PdsPending\n53 = PdsConfirm\n\ 54 = PdsFinalized\n55 = PdsDeclined\n56 = PdsException\n57 = PdsCancelRefused\n\ 58 = PdsCancelUnsuccessful\n59 = Apps\n60 = InhibitedOverride\n61 = PrintedBagTag\n\ 62 = SelfPrintedBagTag\n63 = PrintedBoardingPass\n64 = AddCustomerId\n65 =\ \ DeleteCustomerId\n66 = HoldCreated\n67 = HoldRemoved\n68 = HoldChanged\n\ 69 = OverrideCoupon\n70 = PdsSynchronized\n71 = PdsItemremoved\n72 = Reprice\n\ 73 = ChannelOverride\n74 = EmdCreated\n75 = EmdRemoved\n76 = EmdChanged\n\ 77 = ServiceBundle\n78 = PublishedFareOverride\n79 = FareClassRealignment\n\ 80 = AddedDocument\n81 = ChangedDocument\n82 = DeletedPaymentProperties" x-enumNames: - Unknown - ConvertedHistory - FlightTimeChange - FlightDesignatorChange - AssignedSeat - RemoveSeat - AddedFlight - DeletedFlight - DeletedPassenger - NameChange - GroupNameChange - CancelledTicketing - ScheduleChange - AddedPayment - ServiceFee - QueuedPnr - UnqueuedPnr - DeletedComment - Divided - CheckedIn - CheckedOut - FareOverride - AddedBaggage - ChangedBaggageWeight - CheckedBaggage - RemovedBaggage - BoardedPassenger - UnboardedPassenger - ManualAuthorization - ManualDecline - UndoCancel - ItinerarySent - ContactChange - SsrAdded - FlightMoved - VerifiedDocument - RemovedVerifiedDocument - Promotion - BookingComment - CancelledSchedule - CancelServiceFee - OverrideServiceFee - AddedRecordLocator - DeletedRecordLocator - UpgradeClassOfService - DowngradeClassOfService - StandbyPriorityChange - AssignedTicketNumber - DeletedTicketNumber - ConfirmSegmentStatusCodeChange - CodeshareFlightChanged - PdsCancel - PdsPending - PdsConfirm - PdsFinalized - PdsDeclined - PdsException - PdsCancelRefused - PdsCancelUnsuccessful - Apps - InhibitedOverride - PrintedBagTag - SelfPrintedBagTag - PrintedBoardingPass - AddCustomerId - DeleteCustomerId - HoldCreated - HoldRemoved - HoldChanged - OverrideCoupon - PdsSynchronized - PdsItemremoved - Reprice - ChannelOverride - EmdCreated - EmdRemoved - EmdChanged - ServiceBundle - PublishedFareOverride - FareClassRealignment - AddedDocument - ChangedDocument - DeletedPaymentProperties 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 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 Payment: type: object description: "Defines an applied payment on the booking.\n " additionalProperties: false properties: paymentKey: type: string description: "The payment key that uniquely identifies the payment.\n \ \ " nullable: true code: type: string description: "The payment method code.\n " maxLength: 2 minLength: 0 nullable: true approvalDate: type: string description: "Date when the card/payment is approved in the database.\n\ \ " format: date-time nullable: true details: description: "The payment detail information.\n " nullable: true $ref: '#/components/schemas/PaymentDetails' amounts: description: "The payment amounts and currency codes.\n " nullable: true $ref: '#/components/schemas/PaymentAmounts' authorizationCode: type: string description: "The banks auth code when funds are released.\n " maxLength: 10 minLength: 0 nullable: true authorizationStatus: description: "The real payment status that should never be exposed to the\ \ end user unless a agent.\n " $ref: '#/components/schemas/AuthorizationStatus' fundedDate: type: string description: "The date restriction for a payment (when funds will be there).\n\ \ " format: date-time nullable: true transactionCode: type: string description: "Used for credit shell payments and how to compute the expiration\ \ of the credit.\n " nullable: true dcc: description: "DCC payment details.\n " nullable: true $ref: '#/components/schemas/DirectCurrencyConversion' threeDSecure: description: "3DS payment details.\n " nullable: true $ref: '#/components/schemas/ThreeDSecure' attachments: type: array description: "The list of payment attachments.\n " nullable: true items: $ref: '#/components/schemas/PaymentAttachment' createdDate: type: string description: "The date the payment was created on.\n " format: date-time nullable: true modifiedDate: type: string description: "The date the payment was modified.\n " format: date-time nullable: true type: description: "The payment method type.\n " $ref: '#/components/schemas/PaymentMethodType' status: description: "The status of the booking (this is the safe status).\n \ \ " $ref: '#/components/schemas/BookingPaymentStatus' transferred: type: boolean description: "Flag that indicates if the payment is a result of a divide.\n\ \ " channelType: description: "The channel type that the payment was made through.\n \ \ " $ref: '#/components/schemas/ChannelType' pointOfSale: description: "The payments point of sale information.\n " nullable: true $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The payments source point of sale information.\n \ \ " nullable: true $ref: '#/components/schemas/PointOfSale' deposit: type: boolean description: "Flag indicating if the payment is a deposit.\n " accountId: type: integer description: "Used to identify a credit shell, credit file and agency payments.\n\ \ " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 voucher: description: "The applied voucher details.\n " nullable: true $ref: '#/components/schemas/PaymentVoucherDetails' addedToState: type: boolean description: "Flag indicating if the payment has been added to state or\ \ not.\n " createdAgentId: type: integer description: "The created agents ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 modifiedAgentId: type: integer description: "The modified agents ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 reference: type: integer description: "The reference to the payment.\n " format: int64 passengerVoucher: description: "The passenger voucher.\n " nullable: true $ref: '#/components/schemas/PassengerVoucher' PaymentDetails: type: object description: "Defines the payment details.\n " additionalProperties: false properties: accountNumberId: type: integer description: "The reference of an encrypted account number.\n \ \ " format: int64 parentPaymentId: type: integer description: "ID of the parent of refunds or divide. Null if none exists.\n\ \ " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true accountName: type: string description: "The account holder name.\n " maxLength: 64 minLength: 0 nullable: true accountNumber: type: string description: "The account number.\n " maxLength: 34 minLength: 0 nullable: true expirationDate: type: string description: "The expiration date.\n " format: date-time nullable: true text: type: string description: "The payment added text.\n " maxLength: 64 minLength: 0 nullable: true installments: type: integer description: "The number of installments to be applied.\n " maximum: 999.0 minimum: 0.0 binRange: type: integer description: "The first 6 digits of the credit card number.\n \ \ " format: int32 maximum: 2147483647.0 minimum: 0.0 fields: type: object description: "The collection of payment fields.\n " nullable: true additionalProperties: type: string PaymentAmounts: type: object description: "Defines the different applied payment amounts for a single payment.\n\ \ " additionalProperties: false properties: amount: type: number description: "The amount in the booking currency (based off the origin).\n\ \ " format: decimal currencyCode: type: string description: "The payment amount currency code.\n " maxLength: 3 minLength: 0 nullable: true collected: type: number description: "The collected amount post DCC or MCC.\n " format: decimal collectedCurrencyCode: type: string description: "The collected amounts currency code.\n " maxLength: 3 minLength: 0 nullable: true quoted: type: number description: "The pre DCC or MCC amount (maybe different than the booking).\n\ \ " format: decimal quotedCurrencyCode: type: string description: "The quoted currency code.\n " maxLength: 3 minLength: 0 nullable: true AuthorizationStatus: type: integer description: "Defines the different possible payment authorization states.\n\ \ \n\n0 = Unknown\n1 = Acknowledged\n2 = Pending\n3 = InProcess\n\ 4 = Approved\n5 = Declined\n6 = Referral\n7 = PickUpCard\n8 = HotCard\n9 =\ \ Voided\n10 = Retrieval\n11 = ChargedBack\n12 = Error\n13 = ValidationFailed\n\ 14 = Address\n15 = VerificationCode\n16 = FraudPrevention\n17 = ForcedApproval\n\ 18 = ForcedDecline\n19 = NoResponse\n20 = BadResponse" x-enumNames: - Unknown - Acknowledged - Pending - InProcess - Approved - Declined - Referral - PickUpCard - HotCard - Voided - Retrieval - ChargedBack - Error - ValidationFailed - Address - VerificationCode - FraudPrevention - ForcedApproval - ForcedDecline - NoResponse - BadResponse enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 DirectCurrencyConversion: type: object description: "Defines a direct currency conversion.\n " additionalProperties: false properties: rateId: type: string description: "The rate ID.\n " format: guid currencyCode: type: string description: "The currency code converted to.\n " maxLength: 3 minLength: 0 nullable: true rateValue: type: number description: "The conversion rate value.\n " format: decimal amount: type: number description: "The conversion rate amount.\n " format: decimal putInState: type: string description: "The put in state value.\n " nullable: true status: description: "The conversion status.\n " $ref: '#/components/schemas/DirectCurrencyConversionStatus' applicable: type: boolean description: "Flag indicating if DCC is applicable.\n " DirectCurrencyConversionStatus: type: integer description: "Enumeration that determines the status of a DCC authorization.\n\ \ \n\n0 = DccNotOffered\n1 = DccOfferRejected\n2 = DccOfferAccepted\n\ 3 = DccInitialValue\n4 = MccInUse" x-enumNames: - DccNotOffered - DccOfferRejected - DccOfferAccepted - DccInitialValue - MccInUse enum: - 0 - 1 - 2 - 3 - 4 ThreeDSecure: type: object description: "Defines three D secure.\n " additionalProperties: false properties: browserUserAgent: type: string description: "The browser agent being used.\n " nullable: true browserAccept: type: string description: "The browser agent accept.\n " nullable: true remoteIpAddress: type: string description: "The remote IP address.\n " nullable: true termUrl: type: string description: "The return URL from the bank.\n " nullable: true paReq: type: string description: "The payload that will be sent to the bank site.\n \ \ " nullable: true acsUrl: type: string description: "The URL to redirect to for TDS (aka the bank).\n \ \ " nullable: true paRes: type: string description: "The response that comes back from the bank.\n " nullable: true authResult: type: string description: "The result of 3DS.\n " nullable: true cavv: type: string description: "The encrypted string of prof that 3DS was processed.\n \ \ " nullable: true cavvAlgorithm: type: string description: "The algorithm that created the Cavv.\n " nullable: true eci: type: string description: "The electronic commerce indicator (the level of 3DS).\n \ \ " nullable: true xid: type: string description: "The transaction ID specific to the 3DS 3rd party processing.\n\ \ " nullable: true applicable: type: boolean description: "Flag that indicates if more validation is needed.\n \ \ " successful: type: boolean description: "Flag indicating if 3DS was successful.\n " threeDSecureSessionId: type: string description: "The three d secure session id. This is returned by device\ \ data collection.\nThis ties the device data collection to the 3DSecure\ \ Lookup.\n " nullable: true challengePreference: description: "The requested challenge preference.\nIndicates whether the\ \ merchant would like to force the issuer to present a 3DSecure challenge.\n\ \ " $ref: '#/components/schemas/ChallengePreference' challengeWindowSize: description: "The requested challenge window size.\nIndicates the preferred\ \ size of the 3DSecure challenge window.\n " $ref: '#/components/schemas/ChallengePreferenceWindowSize' transactionIdThreeDSecure: type: string description: "The transaction id three d secure. Used after completing 3DS\ \ Native challenge.\nThis is the equivalent of the 3DSecure Redirect PaRes\ \ value. For 3DSecure Native authentications,\nthe transaction ID should\ \ be populated in lieu of the PaRes.\n " nullable: true threeDSecureVersion: type: string description: "The three d secure version. Indicates the version of 3DS that\ \ was applied during the authentication.\n " nullable: true merchantData: type: string description: "Merchant data.\n " nullable: true redirectJwt: type: string description: "The Jwt object created by SkyPay to use when redirecting a\ \ customer.\n " nullable: true redirectJwtUrl: type: string description: "Secondary url that may be included in lieu or in addition\ \ to the Redirect Url.\n " nullable: true dsTransactionId: type: string description: "The D S transaction id.\n " nullable: true authenticationStatus: description: "The authentication status.\n " $ref: '#/components/schemas/AuthenticationStatus' ChallengePreference: type: integer description: "Defines the challenge preference.\n \n\n0 = NoPreference\n\ 1 = NoChallengeRequested\n2 = ChallengeRequested\n3 = ChallengeMandated" x-enumNames: - NoPreference - NoChallengeRequested - ChallengeRequested - ChallengeMandated enum: - 0 - 1 - 2 - 3 ChallengePreferenceWindowSize: type: integer description: "Defines the challenge preference window size.\n \n\n\ 0 = SizeFullPage\n1 = Size250X400\n2 = Size390X400\n3 = Size500X600\n4 = Size600X400" x-enumNames: - SizeFullPage - Size250X400 - Size390X400 - Size500X600 - Size600X400 enum: - 0 - 1 - 2 - 3 - 4 AuthenticationStatus: type: integer description: "Defines the different possible payment authentication statuses\ \ for 3DS.\n \n\n0 = Unknown\n1 = AuthenticationSuccessful\n2 =\ \ AuthenticationFailed\n3 = AuthenticationCouldNotBePerformed\n4 = AuthenticationAttemptProcessing\n\ 5 = AuthenticationRejected" x-enumNames: - Unknown - AuthenticationSuccessful - AuthenticationFailed - AuthenticationCouldNotBePerformed - AuthenticationAttemptProcessing - AuthenticationRejected enum: - 0 - 1 - 2 - 3 - 4 - 5 PaymentAttachment: type: object description: "Defines a payment attachment.\n " additionalProperties: false properties: id: type: integer description: "The attachment ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 paymentId: type: integer description: "The payment ID attached to.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 attachment: type: string description: "The attachment data.\n " format: byte nullable: true PaymentMethodType: type: integer description: "Defines the payment method types.\n \n\n0 = ExternalAccount\n\ 1 = PrePaid\n2 = AgencyAccount\n3 = CustomerAccount\n4 = Voucher\n5 = Loyalty" x-enumNames: - ExternalAccount - PrePaid - AgencyAccount - CustomerAccount - Voucher - Loyalty enum: - 0 - 1 - 2 - 3 - 4 - 5 BookingPaymentStatus: type: integer description: "Determines if the booking has been paid for or not.\n \ \ \n\n0 = New\n1 = Received\n2 = Pending\n3 = Approved\n4 = Declined\n\ 5 = Unknown\n6 = PendingCustomerAction" x-enumNames: - New - Received - Pending - Approved - Declined - Unknown - PendingCustomerAction enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 PaymentVoucherDetails: type: object description: "Payment voucher details. This describes a voucher applied to a\ \ payment.\n " additionalProperties: false properties: id: type: integer description: "The voucher ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 transactionId: type: integer description: "The vouchers transactions ID.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 overrideRestrictions: type: boolean description: "Flag indicating if the voucher restrictions were overridden.\n\ \ " overrideAmount: type: boolean description: "The amount applied of the voucher.\n " recordLocator: type: string description: "The record locator attached to the voucher.\n " maxLength: 12 minLength: 0 nullable: true PassengerVoucher: type: object description: "Defines a passenger voucher.\n " additionalProperties: false properties: passengerVoucherKey: type: string description: "The passenger voucher key.\n " nullable: true passengerKey: type: string description: "The passenger key.\nWill be null if the voucher does not apply\ \ to a specific passenger.\n " nullable: true voucherConfigurationCode: type: string description: "The voucher configuration code.\n " nullable: true voucherUses: type: array description: "The list of voucher uses.\n " nullable: true items: $ref: '#/components/schemas/PassengerVoucherUsageType' customerPrograms: type: array description: "The list of customer programs.\n " nullable: true items: $ref: '#/components/schemas/PassengerVoucherCustomerProgram' customerNumber: type: string description: "The customer number of the customer record to which the voucher\ \ has been issued.\n " nullable: true PassengerVoucherUsageType: type: integer description: "Passenger voucher usage type specifies what parts of a booking\ \ this voucher can pay for.\n \n\n0 = None\n1 = Fares\n2 = Taxes\n\ 3 = TravelFees\n4 = ServiceFees\n5 = PenaltyFees\n6 = SsrFees\n7 = NonFlightServiceFees\n\ 8 = UpgradeFees\n9 = SeatFees\n10 = SpoilageFees\n11 = NameChangeFees\n12\ \ = ConvenienceFees\n13 = Car\n14 = Hotel\n15 = Insurance\n16 = Activities\n\ 17 = BaseFeeOnly" x-enumNames: - None - Fares - Taxes - TravelFees - ServiceFees - PenaltyFees - SsrFees - NonFlightServiceFees - UpgradeFees - SeatFees - SpoilageFees - NameChangeFees - ConvenienceFees - Car - Hotel - Insurance - Activities - BaseFeeOnly enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 PassengerVoucherCustomerProgram: type: object description: "Defines the passenger voucher customer program.\n " additionalProperties: false properties: programCode: type: string description: "The program code.\n " nullable: true programNumber: type: string description: "The program number.\n " nullable: true AddOn: type: object description: "Defines a booking add on service details.\n " additionalProperties: false properties: paymentRequired: type: boolean description: "Returns true if the component requires a separate\npayment\ \ from the rest of the booking.\n " status: description: "The status of the add on.\n " $ref: '#/components/schemas/AddOnStatus' addOnKey: type: string description: "The unique add on key.\n " nullable: true type: description: "The type of add on.\n " $ref: '#/components/schemas/ProductTypeCode' summary: description: "The components order summary when the order is not available.\n\ \ " nullable: true $ref: '#/components/schemas/AddOnOrderSummary' reference: type: string description: "The component reference.\n " nullable: true created: description: "The created by details.\n " nullable: true $ref: '#/components/schemas/CreatedAddOnDetails' source: description: "The responsible source details.\n " nullable: true $ref: '#/components/schemas/AddOnDetails' declinedText: type: string description: "The declined component text.\n " nullable: true cultureCode: type: string description: "The culture code.\n " nullable: true modifiedDate: type: string description: "The date the component was last modified.\n " format: date-time modifiedAgentReference: type: string description: "The agent reference that modified the component.\n \ \ " nullable: true order: description: "The component order details.\n " nullable: true $ref: '#/components/schemas/Order' isHistorical: type: boolean description: "Flag indicating if the component is historical.\n \ \ " charges: type: array description: "The collection of booking component charges.\n " nullable: true items: $ref: '#/components/schemas/AddOnCharge' AddOnStatus: type: integer description: "An enumeration to indicate the add on's current status.\n \ \ \n\n0 = Unknown\n1 = Active\n2 = Pending\n3 = Confirming\n4 = CancelPending\n\ 5 = Cancelled" x-enumNames: - Unknown - Active - Pending - Confirming - CancelPending - Cancelled enum: - 0 - 1 - 2 - 3 - 4 - 5 ProductTypeCode: type: integer description: "Defines the different travel commerce types.\n \n\n\ 0 = Default\n1 = Insurance\n2 = Activity\n3 = Hotel\n4 = Car" x-enumNames: - Default - Insurance - Activity - Hotel - Car enum: - 0 - 1 - 2 - 3 - 4 AddOnOrderSummary: type: object description: "Defines the details about an order if the order is not available.\n\ \ " additionalProperties: false properties: total: type: number description: "The total price of the order.\n " format: decimal held: type: number description: "The total held amount of the order.\n " format: decimal charged: type: number description: "The total charged amount of the order.\n " format: decimal supplierCode: type: string description: "The order's supplier code.\n " nullable: true beginDate: type: string description: "The order's begin date.\n " format: date-time beginLocation: type: string description: "The order's begin location code.\n " nullable: true endDate: type: string description: "The order's end date.\n " format: date-time endLocation: type: string description: "The order's end location code.\n " nullable: true externalReference: type: string description: "The order's supplier external reference (record locator).\n\ \ " nullable: true description: type: string description: "The order's description.\n " nullable: true externalConfirmationNumber: type: string description: "The order's supplier external confirmation number.\n \ \ " nullable: true CreatedAddOnDetails: type: object description: "Defines a component details.\n " additionalProperties: false properties: agentCode: type: string description: "The created agent code.\n " nullable: true organizationCode: type: string description: "The created organization code.\n " nullable: true domainCode: type: string description: "The created domain code.\n " nullable: true locationCode: type: string description: "The created location code.\n " nullable: true agentReference: type: string description: "The agent key.\n " nullable: true date: type: string description: "The date created.\n " format: date-time AddOnDetails: type: object description: "Defines a booking add on base details.\n " additionalProperties: false properties: agentCode: type: string description: "The created agent code.\n " nullable: true organizationCode: type: string description: "The created organization code.\n " nullable: true domainCode: type: string description: "The created domain code.\n " nullable: true locationCode: type: string description: "The created location code.\n " nullable: true Order: type: object description: "Defines a order.\n " additionalProperties: false properties: orderKey: type: string description: "The unique order key.\n " nullable: true active: type: boolean description: "Flag indicating if the order is active.\n " criteria: description: "The specific order criteria.\n " nullable: true $ref: '#/components/schemas/OrderCriteria' thumbnailFileName: type: string description: "The thumbnail file name.\n " nullable: true quantity: type: integer description: "The quantity.\n " format: int32 usageDate: type: string description: "The usage date for this order.\n " format: date-time externalLocator: type: string description: "The third party external locator.\n " nullable: true description: type: string description: "The orders description.\n " nullable: true descriptionFormatType: type: string description: "The order descriptions format type.\n " nullable: true productDescription: type: string description: "The products description.\n " nullable: true productVariationDescription: type: string description: "The products variations description.\n " nullable: true paymentAction: description: "The payment action.\n " $ref: '#/components/schemas/PaymentAction' amounts: description: "The pricing breakdown.\n " nullable: true $ref: '#/components/schemas/OrderPriceBreakdown' terms: type: array description: "The collection of terms and conditions.\n " nullable: true items: $ref: '#/components/schemas/Term' cancellationTerms: type: array description: "The collection of cancellation terms and conditions.\n \ \ " nullable: true items: $ref: '#/components/schemas/Term' details: type: array description: "The collection of product variation details.\n " nullable: true items: $ref: '#/components/schemas/ProductVariationDetail' fees: type: array description: "The collection of applied fees.\n " nullable: true items: $ref: '#/components/schemas/OrderFee' notes: type: array description: "The collection of notes about the order.\n " nullable: true items: $ref: '#/components/schemas/OrderNote' productVariationKey: type: string description: "The unique product variation key.\n " nullable: true productOrderKey: type: string description: "The unique product order key.\n " nullable: true address: description: "The orders address.\n " nullable: true $ref: '#/components/schemas/OrderAddress' phoneNumbers: type: array description: "The collection of available phone numbers.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' locations: type: array description: "The collection of order locations.\n " nullable: true items: $ref: '#/components/schemas/OrderLocation' customer: description: "The oder customer.\n " nullable: true $ref: '#/components/schemas/OrderCustomer' participants: type: object description: "The collection of order participants.\n " nullable: true additionalProperties: $ref: '#/components/schemas/OrderParticipant' history: type: array description: "The collection of order history entry history.\n \ \ " nullable: true items: $ref: '#/components/schemas/OrderHistory' payment: description: "The applied payment.\n " nullable: true $ref: '#/components/schemas/OrderPayment' parameters: type: array description: "The collection of dynamic order input parameters.\n \ \ " nullable: true items: $ref: '#/components/schemas/InputedParameter' OrderCriteria: type: object description: "Defines a products order criteria.\n " additionalProperties: false properties: countryCode: type: string description: "The country code (source or market of the customer).\n \ \ " nullable: true departmentCode: type: string description: "The department code.\n " nullable: true companyCode: type: string description: "The company code.\n " nullable: true ratingCode: type: string description: "The rating code.\n " nullable: true discountCode: type: string description: "The discount code.\n " nullable: true promotionCode: type: string description: "The promotion code.\n " nullable: true currencyCode: type: string description: "The currency code.\n " nullable: true categoryCode: type: string description: "The category code to search with.\n " nullable: true catalogCode: type: string description: "The catalog code.\n " nullable: true supplierCode: type: string description: "The suppliers code.\n " nullable: true vendorCode: type: string description: "The orders vendor.\n " nullable: true PaymentAction: type: integer description: "Defines payment action that should be taken by selling system\ \ for this service.\n \n\n1 = SellingSystemCollects\n2 = PassThroughHold\n\ 3 = NoPaymentRequired\n4 = ReferToSupplierMessage\n5 = PassThroughCharge" x-enumNames: - SellingSystemCollects - PassThroughHold - NoPaymentRequired - ReferToSupplierMessage - PassThroughCharge enum: - 1 - 2 - 3 - 4 - 5 OrderPriceBreakdown: type: object description: "Defines all the different order price breakdown.\n " additionalProperties: false properties: display: description: "The display prices.\n " nullable: true $ref: '#/components/schemas/Amount' initial: description: "The initial base prices.\n " nullable: true $ref: '#/components/schemas/Amount' markup: description: "The markup prices.\n " nullable: true $ref: '#/components/schemas/Amount' listed: description: "The list prices.\n " nullable: true $ref: '#/components/schemas/Amount' listedDiscount: description: "The list discount prices.\n " nullable: true $ref: '#/components/schemas/Amount' discount: description: "The discount prices.\n " nullable: true $ref: '#/components/schemas/Amount' handling: description: "The handling charge prices.\n " nullable: true $ref: '#/components/schemas/Amount' handlingDiscount: description: "The handling charge discount prices.\n " nullable: true $ref: '#/components/schemas/Amount' dueNow: description: "The amounts due now at payment.\n " nullable: true $ref: '#/components/schemas/AmountDue' dueLater: description: "The amounts due later at pickup.\n " nullable: true $ref: '#/components/schemas/AmountDue' personalizations: type: number description: "The personalized total.\n " format: decimal nullable: true taxable: type: number description: "The taxable total.\n " format: decimal nullable: true services: type: number description: "The services total.\n " format: decimal nullable: true fees: type: number description: "The fees total.\n " format: decimal nullable: true total: type: number description: "The overall cost.\n " format: decimal nullable: true taxRate: type: integer description: "The applied tax rate.\n " format: int32 taxExempt: type: boolean description: "Flag indicating if taxes are exempt.\n " taxAtUnitPrice: type: boolean description: "Flag indicating if taxed at the unit price.\n " Amount: type: object description: "Defines an amount base price and total price.\n " additionalProperties: false properties: value: type: number description: "The base amount value.\n " format: decimal nullable: true total: type: number description: "The total amount.\n " format: decimal nullable: true AmountDue: type: object description: "Defines the amounts due for an order.\n " additionalProperties: false properties: preTax: type: number description: "The pre tax total.\n " format: decimal nullable: true tax: type: number description: "The tax total.\n " format: decimal nullable: true total: type: number description: "The total.\n " format: decimal nullable: true Term: type: object description: "Defines the terms and conditions of an order.\n " additionalProperties: false properties: code: type: string description: "The terms and conditions code.\n " nullable: true description: type: string description: "The description.\n " nullable: true terms: type: string description: "The terms.\n " nullable: true ProductVariationDetail: type: object description: "Defines a products variation detail.\n " additionalProperties: false properties: code: type: string description: "The product variation detail code.\n " nullable: true styleCode: type: string description: "The style code.\n " nullable: true description: type: string description: "The product variation detail description.\n " nullable: true OrderFee: type: object description: "Defines a order fee.\n " additionalProperties: false properties: code: type: string description: "The fee code.\n " nullable: true feeCategoryCode: type: string description: "The charge type code.\n " nullable: true description: type: string description: "The fee description.\n " nullable: true amount: description: "The fees amounts.\n " nullable: true $ref: '#/components/schemas/Amount' foreignAmount: description: "The fees foreign amounts.\n " nullable: true $ref: '#/components/schemas/Amount' type: description: "The type of fee applied.\n " $ref: '#/components/schemas/OrderFeeType' isWaiveable: type: boolean description: "Flag indicating if they specific fee is waiveable.\n \ \ " foreignCurrencyCode: type: string description: "The foreign currency code.\n " nullable: true currencyCode: type: string description: "The currency code.\n " nullable: true isChargeable: type: boolean description: "The currency code.\n " OrderFeeType: type: integer description: "Defines the travel commerce fee types.\n \n\n0 = Default\n\ 1 = Tax\n2 = Markup\n3 = Discount" x-enumNames: - Default - Tax - Markup - Discount enum: - 0 - 1 - 2 - 3 OrderNote: type: object description: "Defines a order note.\n " additionalProperties: false properties: text: type: string description: "The notes text.\n " nullable: true description: type: string description: "The notes description (used to identity the note).\n \ \ " nullable: true created: type: string description: "The created date.\n " format: date-time modified: type: string description: "The modified date.\n " format: date-time OrderAddress: type: object description: "Defines an address with GPS coordinates.\n " additionalProperties: false properties: lineOne: type: string description: "The address line one.\n " nullable: true lineTwo: type: string description: "The address line two.\n " nullable: true lineThree: type: string description: "The address line 3.\n " nullable: true countryCode: type: string description: "The country code.\n " nullable: true provinceState: type: string description: "The province state.\n " nullable: true city: type: string description: "The city.\n " nullable: true postalCode: type: string description: "The postal code.\n " nullable: true coordinates: description: "The GPS coordinates associated with this item address.\n \ \ " nullable: true $ref: '#/components/schemas/Coordinate' Coordinate: type: object description: "The defined coordinates of a location.\n " additionalProperties: false properties: latitude: type: string description: "The locations latitude.\n " nullable: true longitude: type: string description: "The locations longitude.\n " nullable: true OrderLocation: type: object description: "Defines a location.\n " additionalProperties: false required: - code - usageDate properties: code: type: string description: "The unique location code.\n " minLength: 1 usageDate: type: string description: "The usage date at this location.\n " format: date-time minLength: 1 description: type: string description: "The location description.\n " nullable: true utcOffset: type: number description: "The UTC offset.\n " format: float OrderCustomer: type: object description: "Defines an order customer contact details.\n " additionalProperties: false properties: name: description: "The name of the consumer.\n " nullable: true $ref: '#/components/schemas/Name' address: description: "The address of the consumer.\n " nullable: true $ref: '#/components/schemas/ConsumerAddress' dateOfBirth: type: string description: "The date of birth of the consumer.\n " format: date-time nullable: true emailAddress: type: string description: "The email address of the consumer.\n " nullable: true companyName: type: string description: "The company name of the consumer.\n " nullable: true type: type: string description: "The type of consumer (business or residential).\n \ \ " nullable: true homePhone: type: string description: "The home phone number.\n " maxLength: 20 minLength: 0 nullable: true workPhone: type: string description: "The work phone number.\n " maxLength: 20 minLength: 0 nullable: true fax: type: string description: "The fax phone number.\n " maxLength: 20 minLength: 0 nullable: true customerKey: type: string description: "The unique customer key.\n " nullable: true customerNumber: type: string description: "The customer number.\n " nullable: true ConsumerAddress: type: object description: "Defines a consumer address.\n " additionalProperties: false properties: lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true county: type: string description: "The address country.\n " nullable: true OrderParticipant: type: object description: "Defines a orders participant.\n " additionalProperties: false properties: description: type: string description: "The participant description.\n " nullable: true participantTypeCode: type: string description: "The participant type code.\n " nullable: true isPrimary: type: boolean description: "Flag indicating if the participant is the primary.\n \ \ " document: description: "The participant document.\n " nullable: true $ref: '#/components/schemas/ParticipantDocument' name: description: "The name of the consumer.\n " nullable: true $ref: '#/components/schemas/Name' address: description: "The address of the consumer.\n " nullable: true $ref: '#/components/schemas/ConsumerAddress' dateOfBirth: type: string description: "The date of birth of the consumer.\n " format: date-time nullable: true emailAddress: type: string description: "The email address of the consumer.\n " nullable: true companyName: type: string description: "The company name of the consumer.\n " nullable: true type: type: string description: "The type of consumer (business or residential).\n \ \ " nullable: true homePhone: type: string description: "The home phone number.\n " maxLength: 20 minLength: 0 nullable: true workPhone: type: string description: "The work phone number.\n " maxLength: 20 minLength: 0 nullable: true fax: type: string description: "The fax phone number.\n " maxLength: 20 minLength: 0 nullable: true participantKey: type: string description: "The unique participant key.\n " nullable: true ParticipantDocument: type: object description: "Defines a consumer document.\n " additionalProperties: false properties: number: type: string description: "The documents number.\n " nullable: true issuedByCode: type: string description: "The documents issued by code.\n " nullable: true documentTypeCode: type: string description: "The documents type code.\n " nullable: true OrderHistory: type: object description: "Defines a order history transaction.\n " additionalProperties: false properties: code: type: string description: "The status code.\n " nullable: true previousCode: type: string description: "The previous status code.\n " nullable: true note: type: string description: "The history note.\n " nullable: true created: type: string description: "The history entry created date.\n " format: date-time hasError: type: boolean description: "Flag indicating if has an error.\n " OrderPayment: type: object description: "Defines a payment on an order.\n " additionalProperties: false required: - type properties: type: type: string description: "The payment type.\n " minLength: 1 name: description: "The name on the payment.\n " nullable: true $ref: '#/components/schemas/Name' number: type: string description: "The number on the payment.\n " nullable: true expiration: type: string description: "The expiration date.\n " format: date-time nullable: true cvv: type: string description: "The CVV on the payment.\n " nullable: true amount: type: number description: "The applied payment amount.\n " format: decimal description: type: string description: "The payment description.\n " nullable: true issueNumber: type: string description: "The payment issue number.\n " nullable: true address: description: "The payments address.\n " nullable: true $ref: '#/components/schemas/Address' emailAddress: type: string description: "The provided email address.\n " format: email nullable: true phoneNumbers: type: array description: "The collection of phone numbers.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' paymentKey: type: string description: "The unique order payment key.\n " nullable: true currencyCode: type: string description: "The currency code the payment is in (will always be set to\ \ the bookings currency code).\n " nullable: true InputedParameter: type: object description: "Defines a parameter with data input.\n " additionalProperties: false properties: code: type: string description: "The unique code for a supplier parameter.\n " nullable: true description: type: string description: "The description.\n " nullable: true value: type: string description: "The parameters value.\n " nullable: true AddOnCharge: type: object description: "Defines a booking add ons charge.\n " additionalProperties: false properties: type: description: "The charge type.\n " $ref: '#/components/schemas/ChargeType' code: type: string description: "The charge code.\n " nullable: true ticketCode: type: string description: "The charge ticket code.\n " nullable: true collection: description: "The charge collection type.\n " $ref: '#/components/schemas/CollectType' currencyCode: type: string description: "The currency code.\n " nullable: true amount: type: number description: "The charged amount.\n " format: decimal details: type: string description: "The charge details.\n " nullable: true BookingOrder: type: object description: "Represents a booking order.\n " additionalProperties: false properties: bookingOrderKey: type: string description: "The unique identifier.\n " nullable: true orderId: type: string description: "The unique identifier related to a travel commerce order.\n\ For use with TC API.\n " format: guid collect: type: number description: "Total amount of the order that is to be collected directly\ \ by NewSkies.\n " format: decimal thirdPartyCharge: type: number description: "Total amount of the order that will be charged immediately\ \ by a third party.\nFor example, the amount that is charged when an add-on\ \ is booked.\n " format: decimal thirdPartyHold: type: number description: "Total amount of the order that will be charged at the time\ \ of the service by a third party.\nFor example, the amount that is charged\ \ when a car is picked up.\n " format: decimal total: type: number description: "Total face value of the order, including non-chargeable amounts.\n\ \ " format: decimal status: description: "The overall status of the order from a NewSkies perspective,\ \ indicating\ninformation such as if the order has been finalized in Travel\ \ Commerce.\n " $ref: '#/components/schemas/BookingOrderStatus' BookingOrderStatus: type: integer description: "Booking Order Status Enumeration\n \n\n0 = None\n1\ \ = FinalizedProcess" x-enumNames: - None - FinalizedProcess enum: - 0 - 1 IJsonResponseOfBookingInfov2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BookingInfov2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingInfov2: type: object description: "Describes general booking details.\n " additionalProperties: false properties: status: description: "The status of the entire booking.\n " $ref: '#/components/schemas/BookingStatus' paidStatus: description: "The status of the applied payments.\n " $ref: '#/components/schemas/PaidStatus' priceStatus: description: "The pricing status of the booking.\n " $ref: '#/components/schemas/PriceStatus' profileStatus: description: "The booking profiling status.\n " $ref: '#/components/schemas/BookingProfileStatus' bookingType: type: string description: "Identifies the type (Default, GDS, CodeShare, ect) of the\ \ booking set during the commit process.\n " nullable: true channelType: description: "The channel that is responsible for created the booking.\n\ \ " $ref: '#/components/schemas/ChannelType' bookedDate: type: string description: "The UTC date and time the booking was originally created.\n\ \ " format: date-time nullable: true createdDate: type: string description: "The UTC date and time of when the booking was created.\n \ \ " format: date-time nullable: true expirationDate: type: string description: "The UTC date and time indicating when the booking will not\ \ be returned when retrieved by a GDS/GRS.\n " format: date-time nullable: true modifiedDate: type: string description: "The UTC date and time when the booking was last updated on\ \ the server.\n " format: date-time nullable: true modifiedAgentId: type: integer description: "The last agent ID who modified the booking.\n " format: int64 createdAgentId: type: integer description: "The agent ID that created the booking.\n " format: int64 owningCarrierCode: type: string description: "Identifies which carrier is financially responsible for the\ \ booking and payment.\n " maxLength: 3 minLength: 2 nullable: true changeAllowed: type: boolean description: "The flag indicating whether the booking can be changed.\n\ \ " createdUserKey: type: string description: "The user key of the agent ID who created the booking, which\ \ can be used anywhere the userKey is accepted.\n " nullable: true modifiedUserKey: type: string description: "The modified user key of the agent ID who modified the booking\ \ last, which can be used anywhere the userKey is\naccepted.\n \ \ " nullable: true isBookingEligibleForExternalBaggageDisplay: type: boolean description: "Determines if the booking is eligible for external baggage\ \ display.\n " BookingQueueDeleteByKeyRequest: type: object description: "The booking queue delete by queue key request.\n " additionalProperties: false required: - authorizedBy - notes properties: authorizedBy: type: string description: "The authorizing agent.\n " minLength: 1 notes: type: string description: "The notes for the booking request.\n " minLength: 1 password: type: string description: "The password needed to access the queue.\nRequired if queue\ \ is set to password-protected in Sky Manager.\n " nullable: true BookingPointOfSaleEditRequest: type: object description: "Model related to the booking point of sale edit request. This\ \ is to be used for update operations only.\n " additionalProperties: false required: - agentCode - organizationCode properties: agentCode: type: string description: "The point of sale agent code.\n " maxLength: 64 minLength: 0 domainCode: type: string description: "The point of sale domain code.\n " maxLength: 5 minLength: 0 nullable: true locationCode: type: string description: "The point of sale location code.\n " maxLength: 5 minLength: 0 nullable: true organizationCode: type: string description: "The point of sale organization code.\n " maxLength: 10 minLength: 0 isoCountryCode: type: string description: "Two character country code, optionally supplied in GDS message\n\ \ " maxLength: 2 minLength: 0 nullable: true sourceSystemCode: type: string description: "Two character system code, optionally supplied in GDS message\n\ \ " maxLength: 3 minLength: 0 nullable: true DeltaMapperOfBookingPointOfSaleEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: agentCode: type: string description: "The point of sale agent code.\n " maxLength: 64 minLength: 0 domainCode: type: string description: "The point of sale domain code.\n " maxLength: 5 minLength: 0 nullable: true locationCode: type: string description: "The point of sale location code.\n " maxLength: 5 minLength: 0 nullable: true organizationCode: type: string description: "The point of sale organization code.\n " maxLength: 10 minLength: 0 isoCountryCode: type: string description: "Two character country code, optionally supplied in GDS message\n\ \ " maxLength: 2 minLength: 0 nullable: true sourceSystemCode: type: string description: "Two character system code, optionally supplied in GDS message\n\ \ " maxLength: 3 minLength: 0 nullable: true PromotionRequest: type: object description: "Defines the simple request to apply a promotion code.\n \ \ " additionalProperties: false required: - promotionCode properties: promotionCode: type: string description: "The promotion code to be applied.\n " maxLength: 8 minLength: 0 organizationCode: type: string description: "The point of sale organization code.\n " maxLength: 10 minLength: 0 nullable: true IJsonResponseOfRecordLocator: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/RecordLocator' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfRecordLocator: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/RecordLocator' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' RecordLocatorCreateRequest: type: object description: "The record locator create request model.\n " additionalProperties: false properties: systemDomainCode: type: string description: "The system domain code.\n " maxLength: 3 minLength: 0 nullable: true bookingSystemCode: type: string description: "The system code of where the booking was created.\n \ \ " maxLength: 3 minLength: 0 nullable: true hostedCarrierCode: type: string description: "The hosted carrier's code.\n " maxLength: 3 minLength: 0 nullable: true recordCode: type: string description: "The system domain code.\n " maxLength: 12 minLength: 0 nullable: true owningSystemCode: type: string description: "The owning system code for the booking.\n " maxLength: 3 minLength: 0 nullable: true RecordLocatorEditRequest: type: object description: "The record locator edit request model.\n " additionalProperties: false properties: systemDomainCode: type: string description: "The system domain code.\n " maxLength: 3 minLength: 0 nullable: true bookingSystemCode: type: string description: "The system code of where the booking was created.\n \ \ " maxLength: 3 minLength: 0 nullable: true hostedCarrierCode: type: string description: "The hosted carrier's code.\n " maxLength: 3 minLength: 0 nullable: true DeltaMapperOfRecordLocatorEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: systemDomainCode: type: string description: "The system domain code.\n " maxLength: 3 minLength: 0 nullable: true bookingSystemCode: type: string description: "The system code of where the booking was created.\n \ \ " maxLength: 3 minLength: 0 nullable: true hostedCarrierCode: type: string description: "The hosted carrier's code.\n " maxLength: 3 minLength: 0 nullable: true OverrideChannelType: type: integer description: "Defines the available channel types to override to.\n \ \ \n\n0 = Direct\n1 = Web\n2 = Api\n3 = DigitalApi\n4 = DigitalWeb\n5 =\ \ Ndc" x-enumNames: - Direct - Web - Api - DigitalApi - DigitalWeb - Ndc enum: - 0 - 1 - 2 - 3 - 4 - 5 IJsonResponseOfBookingValidationResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BookingValidationResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingValidationResponse: type: object description: "Represents the booking validation response model.\n \ \ " additionalProperties: false properties: issueHeldSeatWarning: type: boolean description: "Indicates that if a booking is committed, the seats might\ \ be lost based on the NewSkies configuration.\n " bookingStatus: description: "The forecasted status that will be applied if the booking\ \ is committed.\nThis will be reflected in the info.status node during\ \ a get booking call.\n " $ref: '#/components/schemas/BookingStatus' PassengerBagUpdateRequest: type: object description: "A model for a request to update the passenger bags.\n \ \ " additionalProperties: false properties: weight: type: integer description: "The baggage weight.\n " maximum: 32767.0 minimum: 0.0 nullable: true weightType: description: "Type of weight for the baggage weight.\n " nullable: true $ref: '#/components/schemas/WeightType' baggageTypeCode: type: string description: "The baggage type code for the check-in request.\nThis can\ \ only be updated if the baggage weight is changed at the same time, and\ \ if\nthe baggage type code is active.\n " nullable: true IJsonResponseOfIListOfSeatMapAvailability: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/SeatMapAvailability' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SeatMapAvailability: type: object description: "Defines the equipment availability.\n " additionalProperties: false properties: seatMap: description: "The seat map.\n " nullable: true $ref: '#/components/schemas/SeatMap' fees: type: object description: "The collection passenger seat group fees to go along with\ \ the collection of seat maps.\n " nullable: true additionalProperties: $ref: '#/components/schemas/PassengerSeatGroupInfo' ssrLookup: type: object description: "The list of SSR's available.\n " nullable: true additionalProperties: $ref: '#/components/schemas/Ssr' SeatMap: type: object description: "Defines a single equipment type and all it's units.\n \ \ " additionalProperties: false properties: name: type: string description: "The name of the equipment.\n " nullable: true arrivalStation: type: string description: "The arrival station.\n " nullable: true departureStation: type: string description: "The departure station.\n " nullable: true marketingCode: type: string description: "The marketing code on the inventory equipment.\n \ \ " nullable: true equipmentType: type: string description: "The equipment label.\n " nullable: true equipmentTypeSuffix: type: string description: "The equipment code/suffix.\n " nullable: true category: description: "The categorization of the equipment.\n " $ref: '#/components/schemas/EquipmentCategory' availableUnits: type: integer description: "Number of available units on the inventory equipment.\n \ \ " format: int32 decks: type: object description: "The collection of decks/levels for the equipment.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/DeckInformation' seatmapReference: type: string description: "The reference identifying what seatmap the leg is in associated\ \ to.\n " nullable: true DeckInformation: type: object description: "Defines a deck within an equipment.\n " additionalProperties: false properties: number: type: integer description: "The deck number.\n " format: int32 compartments: type: object description: "The collection of compartments within the deck.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/CompartmentInformation' CompartmentInformation: type: object description: "Defines a compartment within an equipment -> deck.\n \ \ " additionalProperties: false properties: availableUnits: type: integer description: "The number of available units in the compartment.\n \ \ " format: int32 designator: type: string description: "The unique designator for the compartment.\n " nullable: true length: type: integer description: "The length of the compartment.\n " format: int32 width: type: integer description: "The width of the compartment.\n " format: int32 sequence: type: integer description: "The compartment's sequence number in the equipments deck.\n\ \ " orientation: type: integer description: "The facing orientation this compartment is in.\n \ \ " units: type: array description: "The list of units contained in the compartment.\n \ \ " nullable: true items: $ref: '#/components/schemas/UnitInformation' UnitInformation: type: object description: "Defines a unit within an equipment -> decks -> compartment.\n\ \ " additionalProperties: false properties: unitKey: type: string description: "The key used to assign the unit to a passenger.\n \ \ " nullable: true assignable: type: boolean description: "Flag indicating if the unit is assignable (aka is a seat).\ \ If false this means that the unit is a fixture.\n " availability: description: "The availability of the seat.\n " $ref: '#/components/schemas/SeatAvailability' compartmentDesignator: type: string description: "Defines compartment designator of the compartment to which\ \ unit belongs to.\n " nullable: true designator: type: string description: "Defines unique designator for the unit within the compartment.\n\ \ " nullable: true type: description: "The type of the unit.\n " $ref: '#/components/schemas/UnitType' travelClassCode: type: string description: "The designated travel class code.\n " nullable: true set: type: integer description: "The designator of the group the unit belongs to.\n \ \ " format: int32 group: type: integer description: "Indicates the logical group where this unit belongs. Also\ \ indicating the pricing value of this unit via seat fees.\n \ \ " priority: type: integer description: "Indicates the priority level of this unit, if this unit is\ \ among the best seats computed by the seat assignment\nalgorithm.\n \ \ " text: type: string description: "The text associated to a unit.\n " nullable: true setVacancy: type: integer description: "The number of available units in the group.\n " format: int32 angle: type: integer description: "This angle of the unit in the grid.\n " width: type: integer description: "The grid width of the unit.\n " height: type: integer description: "The grid height of the unit.\n " zone: type: integer description: "Indicates the location of this unit, thereby controlling bookings\ \ and reservations on this unit based on customer\nrecognition levels\ \ and user role settings.\n " x: type: integer description: "The horizontal position of the unit in the grid.\n \ \ " y: type: integer description: "This vertical position of the unit in the grid.\n \ \ " allowedSsrs: type: array description: "The collection of allowed SSR's.\n " nullable: true items: type: string properties: type: array description: "The collection of properties for the specific unit.\n \ \ " nullable: true items: $ref: '#/components/schemas/SeatMapProperty' availabilityPerPassenger: type: object description: "The seat availability per passenger.\n " nullable: true additionalProperties: $ref: '#/components/schemas/SeatAvailability' SeatAvailability: type: integer description: "Defines the type of hold placed on the seat (unit).\n \ \ \n\n0 = Unknown\n1 = Reserved\n2 = Blocked\n3 = HeldForAnotherSession\n\ 4 = HeldForThisSession\n5 = Open\n6 = Missing\n7 = CheckedIn\n8 = FleetBlocked\n\ 9 = Restricted\n10 = Broken\n11 = ReservedForPnr\n12 = SoftBlocked\n13 = Unavailable" x-enumNames: - Unknown - Reserved - Blocked - HeldForAnotherSession - HeldForThisSession - Open - Missing - CheckedIn - FleetBlocked - Restricted - Broken - ReservedForPnr - SoftBlocked - Unavailable enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 SeatMapProperty: type: object description: "Defines a property of a equipment unit.\n " additionalProperties: false properties: code: type: string description: "The dynamic equipment property code.\n " nullable: true value: type: string description: "The dynamic equipment property value.\n " nullable: true PassengerSeatGroupInfo: type: object description: "Defines the equipment seat group details for a specific passenger.\n\ \ " additionalProperties: false properties: passengerKey: type: string description: "The associated passenger key.\n " nullable: true groups: type: object description: "The collection of seat group fees.\n " nullable: true additionalProperties: $ref: '#/components/schemas/SeatGroupInfo' SeatGroupInfo: type: object description: "Information about a equipment seat group.\n " additionalProperties: false properties: group: type: integer description: "The seat group number.\n " fees: type: array description: "The list of seat group fees.\n " nullable: true items: $ref: '#/components/schemas/PassengerFee' Ssr: type: object description: "The sell service request (SSR) model.\n " additionalProperties: false properties: ssrCode: type: string description: "The Ssr code.\n " maxLength: 4 minLength: 1 nullable: true name: type: string description: "The name.\n " maxLength: 64 minLength: 1 nullable: true feeCode: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 nullable: true ssrNestCode: type: string description: "The Ssr nest code.\n " maxLength: 4 minLength: 0 nullable: true traceQueueCode: type: string description: "The trace queue code.\n " maxLength: 6 minLength: 0 nullable: true ssrType: description: "The Ssr type.\n " $ref: '#/components/schemas/SsrType' inActive: type: boolean description: "The in active.\n " unitValue: type: integer description: "The unit value.\n " limitPerPassenger: type: integer description: "The limit per passenger.\n " maximum: 32767.0 minimum: 0.0 boardingZone: type: integer description: "The boarding zone.\n " maximum: 99.0 minimum: 0.0 allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes\ \ endpoint to verify role based access instead.\n " seatMapCode: type: string description: "The seat map code.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 nullable: true seatRestriction: description: "The seat restriction.\n " $ref: '#/components/schemas/SeatRestriction' ruleSetName: type: string description: "The rule set name.\n " nullable: true SsrType: type: integer description: "SsrType enumeration.\n \n\n0 = Standard\n1 = Infant\n\ 2 = Meal\n3 = BaggageAllowance\n4 = TravelLineMeal" x-enumNames: - Standard - Infant - Meal - BaggageAllowance - TravelLineMeal enum: - 0 - 1 - 2 - 3 - 4 SeatRestriction: type: integer description: "The seat restriction enumeration.\n \n\n0 = Undefined\n\ 1 = AlwaysAllowed\n2 = DefaultAllowed\n3 = DefaultRestricted" x-enumNames: - Undefined - AlwaysAllowed - DefaultAllowed - DefaultRestricted enum: - 0 - 1 - 2 - 3 IJsonResponseOfIListOfBookingSearchResult: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BookingSearchResult' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingSearchResult: type: object description: "Booking model data.\n " additionalProperties: false properties: bookingKey: type: string description: "The booking key.\n " nullable: true allowedToModifyGdsBooking: type: boolean description: "Indicates whether it is allowed to modify GDS booking.\n \ \ " bookingStatus: description: "The booking status.\n " $ref: '#/components/schemas/BookingStatus' channelType: description: "The type of the channel.\n " $ref: '#/components/schemas/ChannelType' editable: type: boolean description: "Indicates whether this is editable.\n " expiredDate: type: string description: "The expired date.\n " format: date-time nullable: true flightDate: type: string description: "Flight date.\n " format: date-time nullable: true flightNumber: type: string description: "The flight number.\n " nullable: true origin: type: string description: "Origin.\n " nullable: true passengerId: type: integer description: "The passenger id.\n " format: int64 nullable: true recordLocator: type: string description: "The record locator.\n " nullable: true sourceAgentCode: type: string description: "The source agent code.\n " nullable: true sourceDomainCode: type: string description: "The source domain code.\n " nullable: true sourceOrganizationCode: type: string description: "The source organization code.\n " nullable: true systemCode: type: string description: "The system code.\n " nullable: true destination: type: string description: "Destination.\n " nullable: true name: description: "The name on the booking.\n " nullable: true $ref: '#/components/schemas/Name' SearchBookingsByCreditCard: type: object description: "Search for a booking by credit card.\n " additionalProperties: false required: - creditCardNumber properties: creditCardNumber: type: string description: "The digits of one of the credit card number applied.\n \ \ " maxLength: 34 minLength: 0 agentId: type: integer description: "The agent identifier.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true organizationCode: type: string description: "OrganizationCode represents the organization associated with\ \ the agent who created\nthe booking.\n " maxLength: 10 minLength: 0 nullable: true filters: description: "Common search filters.\n " nullable: true $ref: '#/components/schemas/BookingFilters' BookingFilters: type: object description: "Model representing the booking filters available when searching.\n\ \ " additionalProperties: false properties: pageSize: type: integer description: "The number of items to return for the request.\n \ \ " maximum: 5000.0 minimum: 10.0 nullable: true lastIndex: type: integer description: "The last booking index (used for paging).\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 nullable: true flightNumber: type: string description: "Filter by the flight number.\n " nullable: true departureDate: type: string description: "The first journeys departure date.\n " format: date-time nullable: true destination: type: string description: "Filter by the destination code.\n " maxLength: 3 minLength: 3 nullable: true origin: type: string description: "Filter by the departure code.\n " maxLength: 3 minLength: 3 nullable: true sourceOrganization: type: string description: "Filter by the organization associated with the booking. For\ \ example the\ntravel agency associated with this booking.\n \ \ " maxLength: 10 minLength: 0 nullable: true organizationGroupCode: type: string description: "Filter by the organization group code to find.\n \ \ " maxLength: 3 minLength: 0 nullable: true searchArchive: type: boolean description: "Whether or not to search the booking archive.\n \ \ " nullable: true AddUnitStatelessConfig: type: object description: "Unit sell config defines the different configurations when selling\ \ stateless units.\n " additionalProperties: false properties: ignoreSeatSsrs: type: boolean description: "Flag indicating whether to ignore seat SSR's.\n \ \ " nullable: true collectedCurrencyCode: type: string description: "Optional Currency code if different than booking currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true inventoryControl: description: "Indicates the type of hold placed on a unit.\n " nullable: true $ref: '#/components/schemas/UnitInventoryControlType' UnitInventoryControlType: type: integer description: "Enum indicates the type of hold placed on the seat.\n \ \ \n\n0 = Session\n1 = None" x-enumNames: - Session - None enum: - 0 - 1 DeleteUnitStatelessConfig: type: object description: "Unit delete config defines the different configurations when removing\ \ stateless units.\n " additionalProperties: false properties: ignoreSeatSsrs: type: boolean description: "Flag indicating whether to ignore seat SSR's.\n \ \ " nullable: true BookingVerifiedTravelDocument: type: object description: "The model for a dotRez stateful booking verified travel document.\n\ \ " additionalProperties: false required: - documentTypeCode - issuedByCode properties: documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: string description: "The issuer code for the travel document (country code).\n\ \ " maxLength: 3 minLength: 0 isInfant: type: boolean description: "Flag for if this verified travel document is for an infant\ \ or not.\n " IJsonResponseOfIListOfPhoneNumber: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPhoneNumber: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PhoneNumber' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PhoneNumberBase: type: object description: "Defines a common phone number base.\n " additionalProperties: false required: - number properties: number: type: string description: "The phone number without any formatting characters.\n \ \ " maxLength: 20 minLength: 0 IJsonResponseOfContact: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Contact' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ContactRequest: type: object description: "Defines a contact create request.\n " additionalProperties: false properties: cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 nullable: true address: description: "The contact address.\n " nullable: true $ref: '#/components/schemas/Address' emailAddress: type: string description: "The email address of the contact.\n " nullable: true customerNumber: type: string description: "The customer number.\n " maxLength: 20 minLength: 0 nullable: true sourceOrganization: type: string description: "Source organization.\n " maxLength: 10 minLength: 0 nullable: true distributionOption: description: "The contact distribution option.\n " nullable: true $ref: '#/components/schemas/DistributionOption' notificationPreference: description: "The notification preference of the contact.\n " nullable: true $ref: '#/components/schemas/NotificationPreference' companyName: type: string description: "The company name.\n " maxLength: 64 minLength: 0 nullable: true name: description: "The contact's name.\n " nullable: true $ref: '#/components/schemas/Name' phoneNumbers: type: array description: "The collection of phone numbers.\nSupported types: Home, Work,\ \ Fax, Other.\nThis collections can only contain one number for each supported\ \ type.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' DeltaMapperOfContactBase: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 nullable: true address: description: "The contact address.\n " nullable: true properties: lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true emailAddress: type: string description: "The email address of the contact.\n " nullable: true customerNumber: type: string description: "The customer number.\n " maxLength: 20 minLength: 0 nullable: true sourceOrganization: type: string description: "Source organization.\n " maxLength: 10 minLength: 0 nullable: true distributionOption: description: "The contact distribution option.\n " nullable: true $ref: '#/components/schemas/DistributionOption' notificationPreference: description: "The notification preference of the contact.\n " nullable: true $ref: '#/components/schemas/NotificationPreference' companyName: type: string description: "The company name.\n " maxLength: 64 minLength: 0 nullable: true name: description: "The contact's name.\n " nullable: true properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true ContactBase: type: object description: "Contact model describing a primary contact information.\n \ \ " additionalProperties: false properties: cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 nullable: true address: description: "The contact address.\n " nullable: true $ref: '#/components/schemas/Address' emailAddress: type: string description: "The email address of the contact.\n " nullable: true customerNumber: type: string description: "The customer number.\n " maxLength: 20 minLength: 0 nullable: true sourceOrganization: type: string description: "Source organization.\n " maxLength: 10 minLength: 0 nullable: true distributionOption: description: "The contact distribution option.\n " nullable: true $ref: '#/components/schemas/DistributionOption' notificationPreference: description: "The notification preference of the contact.\n " nullable: true $ref: '#/components/schemas/NotificationPreference' companyName: type: string description: "The company name.\n " maxLength: 64 minLength: 0 nullable: true name: description: "The contact's name.\n " nullable: true $ref: '#/components/schemas/Name' IJsonResponseOfCurrencyConversion: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CurrencyConversion' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CurrencyConversion: type: object description: "Model with the information needed to calculate from one currency\ \ to another.\n " additionalProperties: false required: - fromCurrencyCode - toCurrencyCode - amount - convertedAmount - exchangeRate properties: fromCurrencyCode: type: string description: "The currency code that the amount is currently in.\n \ \ " maxLength: 3 minLength: 1 toCurrencyCode: type: string description: "The currency code we want the amount converted to.\n \ \ " maxLength: 3 minLength: 1 amount: type: number description: "The amount to be converted. This will be in the FromCurrencyCode\ \ currency.\n " format: decimal inverted: type: boolean description: "If set to true, the endpoint will use 1/(exchange rate of\ \ the reverse) during the conversion. Defaults to false if no value is\ \ set.\n " nullable: true convertedAmount: type: number description: "The converted amount. This will be in the ToCurrencyCode currency.\n\ \ " format: decimal exchangeRate: type: number description: "Gets or sets the exchange rate for this external rate.\n \ \ " format: decimal roundingFactor: type: number description: "The default rounding factor of the currency conversion.\n\ \ " format: decimal marketingRoundingFactor: type: number description: "The marketing rounding factor of the currency conversion.\n\ \ " format: decimal IJsonResponseOfBoolean: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: boolean description: "The payload data.\n " errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfFareRule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/FareRule' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareRule: type: object description: "Defines a fare rule and its data.\n " additionalProperties: false properties: fareSellKey: type: string description: "The fare sell key that is in reference to the fare rule.\n\ \ " nullable: true content: type: string description: "The fare rule content.\n " nullable: true IJsonResponseOfIListOfFeeDetail: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/FeeDetail' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FeeDetail: type: object description: "Fee detail model.\n " additionalProperties: false properties: number: type: integer description: "Gets or sets the fee option number of this fee option.\n \ \ " maximum: 32767.0 minimum: 0.0 feeRules: type: array description: "Gets or sets the fee rules for this fee option.\n \ \ " nullable: true items: $ref: '#/components/schemas/FeeRule' name: type: string description: "Gets or sets the name for this fee option.\n " maxLength: 64 minLength: 0 nullable: true regionFees: type: array description: "Gets or sets the region fees for this fee option.\n \ \ " nullable: true items: $ref: '#/components/schemas/RegionFee' taxApplicationOverride: description: "Gets or sets the override of how to apply the taxes.\n \ \ " $ref: '#/components/schemas/TaxApplication' travelComponentOverride: description: "Gets or sets the override for the travel component.\n \ \ " $ref: '#/components/schemas/TravelComponent' useOverrides: type: boolean description: "Gets or sets the flag for using the overrides.\n \ \ " feeApplicationOverride: description: "Gets or sets the override for where to apply this fee option.\n\ \ " $ref: '#/components/schemas/FeeApplication' FeeRule: type: object description: "Fee rule model.\n " additionalProperties: false properties: number: type: integer description: "Gets or sets the fee option number for this fee rule.\n \ \ " maximum: 32767.0 minimum: 0.0 ruleNumber: type: integer description: "Gets or sets the fee rule number for this fee rule.\n \ \ " maximum: 32767.0 minimum: 0.0 properties: type: array description: "Gets or sets the list of fee rule properties for this fee\ \ rule.\n " nullable: true items: $ref: '#/components/schemas/FeeRuleProperty' operator: description: "Gets or sets the fee rule operator for this fee rule.\n \ \ " $ref: '#/components/schemas/FeeRuleOperator' FeeRuleProperty: type: object description: "Fee rule property model.\n " additionalProperties: false properties: propertyNumber: type: integer description: "Gets or sets the fee property number of this fee rule property.\n\ \ " maximum: 32767.0 minimum: 0.0 ruleNumber: type: integer description: "Gets or sets the fee rule number of this fee rule property.\n\ \ " maximum: 32767.0 minimum: 0.0 operator: description: "Gets or sets the property operator of this fee rule property.\n\ \ " $ref: '#/components/schemas/FeeRulePropertyOperator' type: description: "Gets or sets the property type of this fee rule property.\n\ \ " $ref: '#/components/schemas/FeeRulePropertyType' propertyValue: type: string description: "Gets or sets the property value of this fee rule property.\n\ \ " maxLength: 6 minLength: 0 nullable: true FeeRulePropertyOperator: type: integer description: "Enum representing the fee rule property operator.\n \ \ \n\n0 = Default\n1 = MustBe\n2 = MustNotBe\n3 = AllMustBe" x-enumNames: - Default - MustBe - MustNotBe - AllMustBe enum: - 0 - 1 - 2 - 3 FeeRulePropertyType: type: integer description: "Types of fee rules available.\n \n\n0 = Default\n1\ \ = PassengerType\n2 = FromStationClass\n3 = FareClass\n4 = PassengerResidentCountry\n\ 5 = FeeCode\n6 = ToStationClass\n7 = EventChannel\n8 = OrganizationGroup\n\ 9 = OrganizationCode\n10 = AgentRole\n11 = BestCustomerProgramLevel\n12 =\ \ WorstCustomerProgramLevel\n13 = ExactCustomerProgramLevel\n14 = CarrierCode\n\ 15 = SeatGroup\n16 = FeeType\n17 = ProductClass\n18 = SystemCode\n19 = TripType\n\ 20 = PaymentType\n21 = TicketAccountingCode\n22 = SoldChannel\n23 = ItineraryFullyWithinCountry\n\ 24 = ChangeReasonCode\n25 = GuestRecognitionLevel\n26 = FlightType\n27 = FareType\n\ 28 = DayOfWeek\n29 = StartTimeOfDay\n30 = EndTimeOfDay\n31 = StartFlightNumberRange\n\ 32 = EndFlightNumberRange\n33 = MinAdvancedPurchaseDays\n34 = FareDiscount\n\ 35 = BookingStatus\n36 = EarliestAdvancedPurchaseDays\n37 = SalesStartTimeOfDay\n\ 38 = SalesEndTimeOfDay\n39 = BookingCurrency\n40 = CardSubType\n41 = PaymentMethodCode\n\ 42 = ServiceBundle\n43 = CreatedAgentRoleCode\n44 = StartExtraBagRange\n45\ \ = EndExtraBagRange\n46 = JourneyDepartureStation\n47 = JourneyDepartureCountry\n\ 48 = GSTStateCode\n49 = SystemType\n50 = FarePriceType\n51 = GSTTaxOption\n\ 52 = LatestAdvancedPurchaseDays\n53 = TravelDirection\n54 = TransferAndStopoverPoint" x-enumNames: - Default - PassengerType - FromStationClass - FareClass - PassengerResidentCountry - FeeCode - ToStationClass - EventChannel - OrganizationGroup - OrganizationCode - AgentRole - BestCustomerProgramLevel - WorstCustomerProgramLevel - ExactCustomerProgramLevel - CarrierCode - SeatGroup - FeeType - ProductClass - SystemCode - TripType - PaymentType - TicketAccountingCode - SoldChannel - ItineraryFullyWithinCountry - ChangeReasonCode - GuestRecognitionLevel - FlightType - FareType - DayOfWeek - StartTimeOfDay - EndTimeOfDay - StartFlightNumberRange - EndFlightNumberRange - MinAdvancedPurchaseDays - FareDiscount - BookingStatus - EarliestAdvancedPurchaseDays - SalesStartTimeOfDay - SalesEndTimeOfDay - BookingCurrency - CardSubType - PaymentMethodCode - ServiceBundle - CreatedAgentRoleCode - StartExtraBagRange - EndExtraBagRange - JourneyDepartureStation - JourneyDepartureCountry - GSTStateCode - SystemType - FarePriceType - GSTTaxOption - LatestAdvancedPurchaseDays - TravelDirection - TransferAndStopoverPoint 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 - 52 - 53 - 54 FeeRuleOperator: type: integer description: "Enum for fee rule operator.\n \n\n0 = Default\n1 =\ \ MustBe\n2 = MustNotBe" x-enumNames: - Default - MustBe - MustNotBe enum: - 0 - 1 - 2 RegionFee: type: object description: "Region fee model.\n " additionalProperties: false properties: controlLimit: type: integer description: "Gets or sets the control limit of this region fee.\n \ \ " countryCode: type: string description: "Gets or sets the country code of this region fee.\n \ \ " nullable: true deducted: type: boolean description: "Gets or sets the deducted flag of this region fee.\n \ \ " deductionType: description: "Gets or sets the deduction type of this region fee.\n \ \ " $ref: '#/components/schemas/DeductionType' defaultCurrencyCode: type: string description: "Gets or sets the default currency code of this region fee.\n\ \ " maxLength: 3 minLength: 0 nullable: true directionality: description: "Gets or sets the directionality of this region fee.\n \ \ " $ref: '#/components/schemas/Directionality' discontinueDate: type: string description: "Gets or sets the discontinue date of this region fee.\n \ \ " format: date-time nullable: true feeOptionNumber: type: integer description: "Gets or sets the fee option number for this region fee.\n\ \ " ratePercent: type: number description: "Gets or sets the rate percent for this region fee.\n \ \ " format: decimal regionCode: type: string description: "Gets or sets the region code for this region fee.\n \ \ " maxLength: 5 minLength: 0 nullable: true baggage: description: "Gets or sets the baggage for this region fee.\n \ \ " nullable: true $ref: '#/components/schemas/RegionFeeBaggage' id: type: integer description: "Gets or sets the id for this region fee.\n " format: int64 nullable: true regionRates: type: array description: "Gets or sets the list for region rates for this region fee.\n\ \ " nullable: true items: $ref: '#/components/schemas/RegionRate' regionType: description: "Gets or sets the region type for this region fee.\n \ \ " $ref: '#/components/schemas/RegionType' releaseDate: type: string description: "Gets or sets the release date for this region fee.\n \ \ " format: date-time nullable: true travelCountryCode: type: string description: "Gets or sets the travel country code for this region fee.\n\ \ " nullable: true travelDiscontinueDate: type: string description: "Gets or sets the travel discount date for this region fee.\n\ \ " format: date-time nullable: true travelRegionCode: type: string description: "Gets or sets the travel region code for this region.\n \ \ " maxLength: 5 minLength: 0 nullable: true travelRegionType: description: "Gets or sets the travel region type for this region.\n \ \ " $ref: '#/components/schemas/RegionType' travelReleaseDate: type: string description: "Gets or sets the travel release date for this region.\n \ \ " format: date-time nullable: true travelSegmentIndicator: description: "Gets or sets the travel segment indicator for this region.\n\ \ " $ref: '#/components/schemas/TravelSegmentIndicator' DeductionType: type: integer description: "Enumeration representing the deduction type to be applied to fees/taxes.\n\ \ \n\n0 = All\n1 = First\n2 = Last\n3 = ExceptForFirst\n4 = ExceptForLast\n\ 5 = None" x-enumNames: - All - First - Last - ExceptForFirst - ExceptForLast - None enum: - 0 - 1 - 2 - 3 - 4 - 5 Directionality: type: integer description: "Enum representing direction of an object.\n \n\n0 =\ \ None\n1 = To\n2 = From\n3 = Between" x-enumNames: - None - To - From - Between enum: - 0 - 1 - 2 - 3 RegionFeeBaggage: type: object description: "Region rate model.\n " additionalProperties: false properties: weightDivisorKgs: type: integer description: "Divisor value for weight in Kilograms.\n " weightDivisorLbs: type: integer description: "Divisor value for weight in pounds.\n " RegionRate: type: object description: "Region rate model.\n " additionalProperties: false required: - regionCode properties: currencyCode: type: string description: "The currency code of this region rate.\n " maxLength: 3 minLength: 0 nullable: true rateAmount: type: number description: "The rate amount of this region rate.\n " format: decimal regionCode: type: string description: "The region code of this region rate.\n " maxLength: 5 minLength: 0 regionFeeId: type: integer description: "The region fee ID of this region rate.\n " format: int64 nullable: true regionRateId: type: integer description: "The region rate ID of this region rate.\n " format: int64 regionType: description: "The type of this region rate.\n " $ref: '#/components/schemas/RegionType' RegionType: type: integer description: "Enum reprenting the the region type used to indicate the kind\ \ of region an item is associated with.\n \n\n0 = Default\n1 =\ \ Station\n2 = City\n3 = ProvinceState\n4 = Country\n5 = FeeZone\n6 = SubZone\n\ 7 = Area\n8 = All\n9 = Mac" x-enumNames: - Default - Station - City - ProvinceState - Country - FeeZone - SubZone - Area - All - Mac enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 TravelSegmentIndicator: type: integer description: "Enumeration representing TSI Codes\n \n\n0 = None\n\ 1 = CheckAgainstJourney\n2 = CheckAgainstTrip\n100 = Departure\n101 = DepartureOfTripOrigin\n\ 102 = DepartureAtConnection\n103 = DepartureWithinStopoverTime\n104 = DepartureAtPointOfTurnaround\n\ 105 = DepartureOfTransOceanicSegment\n106 = DepartureFromGateway\n107 = DepartureOfLastSegment\n\ 108 = DepartureExceedsStopoverTime\n109 = NotDepartingViaConnection\n110 =\ \ GroundTimeBeforeDepartureOfJourneyWithin\n111 = GroundTimeBeforeDepartureOfJourneyExceeds\n\ 200 = Arrival\n201 = ArrivalOfTransOceanicSegment\n202 = ArrivalAtGateway\n\ 203 = ArrivalAtPointOfTurnaround\n204 = ArrivalAtConnection\n206 = ArrivalAtTripOrigin\n\ 207 = NotDepartingViaConnectionOnSameCalendarDay\n208 = CheckAgainstItinerary\n\ 209 = GroundTimeAfterArrivalAtConnectionWithin\n210 = GroundTimeAfterArrivalAtConnectionExceeds\n\ 211 = GroundTimeAfterArrivalOfJourneyWithin\n212 = GroundTimeAfterArrivalOfJourneyExceeds\n\ 213 = ArrivalAtTripOriginCountry\n214 = ArrivalAtTripOriginCity\n215 = DepartingSameCalendarDay\n\ 216 = NotDepartingSameCalendarDay" x-enumNames: - None - CheckAgainstJourney - CheckAgainstTrip - Departure - DepartureOfTripOrigin - DepartureAtConnection - DepartureWithinStopoverTime - DepartureAtPointOfTurnaround - DepartureOfTransOceanicSegment - DepartureFromGateway - DepartureOfLastSegment - DepartureExceedsStopoverTime - NotDepartingViaConnection - GroundTimeBeforeDepartureOfJourneyWithin - GroundTimeBeforeDepartureOfJourneyExceeds - Arrival - ArrivalOfTransOceanicSegment - ArrivalAtGateway - ArrivalAtPointOfTurnaround - ArrivalAtConnection - ArrivalAtTripOrigin - NotDepartingViaConnectionOnSameCalendarDay - CheckAgainstItinerary - GroundTimeAfterArrivalAtConnectionWithin - GroundTimeAfterArrivalAtConnectionExceeds - GroundTimeAfterArrivalOfJourneyWithin - GroundTimeAfterArrivalOfJourneyExceeds - ArrivalAtTripOriginCountry - ArrivalAtTripOriginCity - DepartingSameCalendarDay - NotDepartingSameCalendarDay enum: - 0 - 1 - 2 - 100 - 101 - 102 - 103 - 104 - 105 - 106 - 107 - 108 - 109 - 110 - 111 - 200 - 201 - 202 - 203 - 204 - 206 - 207 - 208 - 209 - 210 - 211 - 212 - 213 - 214 - 215 - 216 TaxApplication: type: integer description: "Enumeration representing how taxes are applied to a fee.\n \ \ \n\n0 = Unknown\n1 = Taxable\n2 = TaxableLocal\n3 = NonTaxable\n\ 4 = NonTaxableApplyToBaseFareOnly\n5 = TaxableByTrip\n6 = TaxableByItinerary" x-enumNames: - Unknown - Taxable - TaxableLocal - NonTaxable - NonTaxableApplyToBaseFareOnly - TaxableByTrip - TaxableByItinerary enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 TravelComponent: type: integer description: "Enumeration for a travel component type.\n \n\n0 =\ \ Unknown\n1 = Itinerary\n2 = Trip\n3 = Journey\n4 = Segment\n5 = Leg\n6 =\ \ SpecificLeg\n9 = ItineraryWithJourneySalesDate\n10 = TripWithJourneySalesDate\n\ 11 = JourneyWithBookingSalesDate\n12 = JourneyWithJourneySalesDate\n13 = SegmentWithJourneySalesDate\n\ 14 = LegWithJourneySalesDate\n15 = Fare\n16 = LegWithConfirmingSalesDate\n\ 17 = SegmentWithConfirmingSalesDate\n18 = JourneyWithConfirmingSalesDate" x-enumNames: - Unknown - Itinerary - Trip - Journey - Segment - Leg - SpecificLeg - ItineraryWithJourneySalesDate - TripWithJourneySalesDate - JourneyWithBookingSalesDate - JourneyWithJourneySalesDate - SegmentWithJourneySalesDate - LegWithJourneySalesDate - Fare - LegWithConfirmingSalesDate - SegmentWithConfirmingSalesDate - JourneyWithConfirmingSalesDate enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 FeeApplication: type: integer description: "Enumeration representing how and where fees are to be applied.\n\ \ \n\n0 = Pnr\n1 = TravelComponent\n2 = EachPassenger\n3 = EachPassengerTravelComponent\n\ 4 = SpecifyPassenger\n5 = AllPaxCheckingBagsTogether\n6 = PerBookingNoLimit" x-enumNames: - Pnr - TravelComponent - EachPassenger - EachPassengerTravelComponent - SpecifyPassenger - AllPaxCheckingBagsTogether - PerBookingNoLimit enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 IJsonResponseOfIListOfJourney: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Journey' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfJourney: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Journey' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CancelJourneyRequest: type: object description: "Defines the options available when canceling a journey.\n \ \ " additionalProperties: false properties: waivePenaltyFee: type: boolean description: "Flag indicating to waive penalty fees if role permitting.\n\ \ " nullable: true waiveSpoilageFee: type: boolean description: "Flag indicating to waive spoilage fees if role permitting.\n\ \ " nullable: true preventReprice: type: boolean description: "Flag indicating to prevent reprice if role permitting.\n \ \ " nullable: true forceRefareForItineraryIntegrity: type: boolean description: "Flag indicating to invoke price with force refare itinerary\ \ set to true (default value is set to true).\n " nullable: true IropMoveRequest: type: object description: "Defines the irop move request for a booking.\n " additionalProperties: false required: - fromJourneyKey - journeyKey - fareKey properties: fromJourneyKey: type: string description: "The journey key to move from.\n " minLength: 1 journeyKey: type: string description: "The journey key to move to.\n " minLength: 1 fareKey: type: string description: "The fare key to move to.\n " minLength: 1 moveAsDiversion: type: boolean description: "Whether to perform the move as a diversion or not. Defaults\ \ to false.\n " overSell: type: boolean description: "If true then the move will be allowed even if the legs of\ \ FromJourney have been\nmarked as Closed.\nIf false, the move will be\ \ disallowed if any one of the legs\nof FromJourney has been marked as\ \ Closed.\n " changeStatus: type: boolean description: "If ChangeStatus is true, the status of the new segments will\ \ be set to\nthe opposite of the status of the original (moving from)\ \ segment. If the\noriginal segments were waitlisted, then new segments\ \ will not be. If the\noriginal segments were not waitlisted, the new\ \ segments will be waitlisted.\nThis does not need to be set to true if\ \ moving to a standby journey that is\nalready part of the booking.\n\ \ " boardingSequenceOffset: type: integer description: "If set to zero and MoveAsDiversion is false, the boarding\ \ sequence\nof the original segments will be copied to the new (moved\ \ to) segments.\nIf set to a value other than zero and MoveAsDiversion\ \ is false,\nthe boarding sequence of the original segments will be copied\ \ to the new (moved to)\nsegments and then incremented by the specified\ \ BoardingSequenceOffset.\nBoarding sequence is not preserved for Diversion\ \ moves.\n " standbyPriorityCode: type: string description: "Standby priority code.\n " nullable: true inventoryControlType: description: "The IROP inventory control type.\n " $ref: '#/components/schemas/IropInventoryControlType' IropInventoryControlType: type: integer description: "Defines the different ways inventory is held at the time of sell\ \ for an irop move.\n \n\n0 = ClaimSpace\n1 = OversellSpace\n2\ \ = StandBy" x-enumNames: - ClaimSpace - OversellSpace - StandBy enum: - 0 - 1 - 2 OneTimeNotificationCreateRequest: type: object description: "Request for one time notification creation.\n " additionalProperties: false properties: cultureCode: type: string description: "The culture code.\n " nullable: true notificationDestination: description: "The notification destination.\n " nullable: true $ref: '#/components/schemas/NotificationDestination' deviceName: type: string description: "The name of the device for the push notification.\n \ \ " nullable: true events: type: array description: "The list of one time travel notification event.\n \ \ " nullable: true items: $ref: '#/components/schemas/OneTimeNotificationEventCreateRequest' timedEvents: type: array description: "The list of travel notification event.\n " nullable: true items: $ref: '#/components/schemas/NotificationTimedEventCreateRequest' marketInformation: description: "The market to create a notification for.\n " nullable: true $ref: '#/components/schemas/MarketInformation' NotificationDestination: type: object description: "A travel notification destination.\n " additionalProperties: false required: - deliveryMethodCode properties: deliveryMethodCode: description: "The delivery method code.\n " $ref: '#/components/schemas/DeliveryMethodCode' destination: type: string description: "The notification destination, an email or phone number.\n\ \ " nullable: true DeliveryMethodCode: type: integer description: "Represents the delivery method codes.\n \n\n0 = Email\n\ 1 = Sms\n2 = Push" x-enumNames: - Email - Sms - Push enum: - 0 - 1 - 2 OneTimeNotificationEventCreateRequest: type: object description: "A one time travel notification event create request.\n \ \ " additionalProperties: false required: - type properties: type: description: "The one time travel notification event type.\n " $ref: '#/components/schemas/OneTimeNotificationEventType' OneTimeNotificationEventType: type: integer description: "Represents the type of notification event type for a one time\ \ travel notification event.\n \n\n0 = DepartureDelay\n1 = ArrivalDelay" x-enumNames: - DepartureDelay - ArrivalDelay enum: - 0 - 1 NotificationTimedEventCreateRequest: type: object description: "A travel notification timed event create request.\n \ \ " additionalProperties: false required: - type properties: minutesToEvent: type: integer description: "The minutes to the event.\n " format: int32 type: description: "The travel notification timed event type.\n " $ref: '#/components/schemas/NotificationTimedEventType' NotificationTimedEventType: type: integer description: "Represents the type of timed notification event type for a travel\ \ notification event.\nThese are events that have an associated property minutes\ \ to event.\n \n\n0 = Departure\n1 = Arrival" x-enumNames: - Departure - Arrival enum: - 0 - 1 IJsonResponseOfOneTimeTravelNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/OneTimeTravelNotification' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' OneTimeTravelNotification: type: object description: "A one time travel notification.\n " additionalProperties: false properties: oneTimeTravelNotificationKey: type: string description: "The one time travel notification key.\n " nullable: true events: type: array description: "The list of one time travel notification event.\n \ \ " nullable: true items: $ref: '#/components/schemas/OneTimeNotificationEvent' timedEvents: type: array description: "The list of travel notification event.\n " nullable: true items: $ref: '#/components/schemas/NotificationTimedEvent' cultureCode: type: string description: "The culture code.\n " nullable: true notificationDestination: description: "The notification destination.\n " nullable: true $ref: '#/components/schemas/NotificationDestination' deviceName: type: string description: "The name of the device for the push notification.\n \ \ " nullable: true expirationDate: type: string description: "The expiration date.\n " format: date-time nullable: true createdDate: type: string description: "The created date of the travel notification.\n " format: date-time nullable: true OneTimeNotificationEvent: type: object description: "A one time notification event.\n " additionalProperties: false required: - type properties: type: description: "The one time travel notification event type.\n " $ref: '#/components/schemas/OneTimeNotificationEventType' createdDate: type: string description: "The created date of the travel notification.\n " format: date-time nullable: true NotificationTimedEvent: type: object description: "A travel notification timed event.\n " additionalProperties: false required: - type properties: type: description: "The travel notification timed event type.\n " $ref: '#/components/schemas/NotificationTimedEventType' minutesToEvent: type: integer description: "The minutes to the event.\n " format: int32 createdDate: type: string description: "The created date of the travel notification.\n " format: date-time nullable: true IJsonResponseOfIListOfPassengerAddress: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerAddress' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerAddress: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerAddress' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIDictionaryOfStringAndPassengerPriceBreakdown: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: $ref: '#/components/schemas/PassengerPriceBreakdown' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIDictionaryOfStringAndPassengerTypePriceBreakdown: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: $ref: '#/components/schemas/PassengerTypePriceBreakdown' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerTypePriceBreakdown: type: object description: "Defines the unique passenger type level pricing breakdown.\n \ \ " additionalProperties: false properties: services: description: "The charge breakdown of the service fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' specialServices: description: "The charge breakdown of the special service requests.\n \ \ " nullable: true $ref: '#/components/schemas/ChargeBreakdown' seats: description: "The charge breakdown of seat fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' upgrades: description: "The charge breakdown of upgrade fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' spoilage: description: "The charge breakdown of spoilage fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' nameChanges: description: "The charge breakdown of name change fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' convenience: description: "The charge breakdown of convenience fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' infant: description: "The charge breakdown of infant fees.\n " nullable: true $ref: '#/components/schemas/ChargeBreakdown' totalCost: type: number description: "The total cost for the passenger.\nThese values are only populated\ \ by NewSkies after a booking commit\n " format: decimal nullable: true passengerTypeCode: type: string description: "The passenger type code.\n " nullable: true IJsonResponseOfPassengerPriceBreakdown: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerPriceBreakdown' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIDictionaryOfStringAndPassenger: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: $ref: '#/components/schemas/Passenger' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPassenger: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Passenger' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPassengerEmdCoupon: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerEmdCoupon' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerEmdCoupon: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerEmdCoupon' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerInfant: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerInfant' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerInfantCreateRequest: type: object description: "Model representing infant data that can be set.\n " additionalProperties: false properties: nationality: type: string description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 nullable: true residentCountry: type: string description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 nullable: true dateOfBirth: type: string description: "The date of birth of the infant.\n " format: date-time nullable: true gender: description: "The gender of the passenger.\n " nullable: true $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " nullable: true $ref: '#/components/schemas/Name' declaredGender: type: string description: "The infant's declared gender. A value of \"F\" is mapped to\ \ a female binary gender. All other values will be\nmapped to a male binary\ \ gender.\n " maxLength: 2 minLength: 0 nullable: true travelDocuments: type: array description: "Travel Documents.\n " nullable: true items: $ref: '#/components/schemas/PassengerTravelDocument' IJsonResponseOfIListOfPassengerTravelDocument: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerTravelDocument' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerTravelDocument: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerTravelDocument' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' NotificationEventCreateRequest: type: object description: "A travel notification event create request.\n " additionalProperties: false required: - type properties: type: description: "The travel notification event type.\n " $ref: '#/components/schemas/NotificationEventType' NotificationEventType: type: integer description: "Represents the type of notification event type for a travel notification\ \ event.\n \n\n0 = DepartureDelay\n1 = ArrivalDelay\n2 = ScheduleChange\n\ 3 = CheckIn\n4 = GateInformation" x-enumNames: - DepartureDelay - ArrivalDelay - ScheduleChange - CheckIn - GateInformation enum: - 0 - 1 - 2 - 3 - 4 IJsonResponseOfIListOfNotificationEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/NotificationEvent' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' NotificationEvent: type: object description: "A travel notification event.\n " additionalProperties: false required: - type properties: type: description: "The travel notification event type.\n " $ref: '#/components/schemas/NotificationEventType' createdDate: type: string description: "The created date of the travel notification.\n " format: date-time nullable: true IJsonResponseOfNotificationEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/NotificationEvent' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfNotificationTimedEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/NotificationTimedEvent' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfNotificationTimedEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/NotificationTimedEvent' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' NotificationTimedEventEditRequest: type: object description: "A travel notification timed event edit request.\n " additionalProperties: false properties: minutesToEvent: type: integer description: "The minutes to the event.\n " format: int32 TravelNotificationCreateRequest: type: object description: "Create request for travel notifications.\n " additionalProperties: false properties: cultureCode: type: string description: "The culture code.\n " nullable: true notificationDestination: description: "The notification destination.\n " nullable: true $ref: '#/components/schemas/NotificationDestination' deviceName: type: string description: "The name of the device for the push notification.\n \ \ " nullable: true events: type: array description: "The list of travel notification event.\n " nullable: true items: $ref: '#/components/schemas/NotificationEventCreateRequest' timedEvents: type: array description: "The list of travel notification event.\n " nullable: true items: $ref: '#/components/schemas/NotificationTimedEventCreateRequest' IJsonResponseOfIListOfTravelNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/TravelNotification' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TravelNotification: type: object description: "A travel notification.\n " additionalProperties: false properties: travelNotificationKey: type: string description: "The travel notification key.\n " nullable: true events: type: array description: "The list of travel notification event.\n " nullable: true items: $ref: '#/components/schemas/NotificationEvent' timedEvents: type: array description: "The list of travel notification event.\n " nullable: true items: $ref: '#/components/schemas/NotificationTimedEvent' cultureCode: type: string description: "The culture code.\n " nullable: true notificationDestination: description: "The notification destination.\n " nullable: true $ref: '#/components/schemas/NotificationDestination' deviceName: type: string description: "The name of the device for the push notification.\n \ \ " nullable: true expirationDate: type: string description: "The expiration date.\n " format: date-time nullable: true createdDate: type: string description: "The created date of the travel notification.\n " format: date-time nullable: true IJsonResponseOfTravelNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/TravelNotification' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TravelNotificationEditRequest: type: object description: "Request base for travel notifications.\n " additionalProperties: false properties: cultureCode: type: string description: "The culture code.\n " nullable: true notificationDestination: description: "The notification destination.\n " nullable: true $ref: '#/components/schemas/NotificationDestination' deviceName: type: string description: "The name of the device for the push notification.\n \ \ " nullable: true DeltaMapperOfTravelNotificationEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: cultureCode: type: string description: "The culture code.\n " nullable: true notificationDestination: description: "The notification destination.\n " nullable: true properties: deliveryMethodCode: description: "The delivery method code.\n " $ref: '#/components/schemas/DeliveryMethodCode' destination: type: string description: "The notification destination, an email or phone number.\n\ \ " nullable: true deviceName: type: string description: "The name of the device for the push notification.\n \ \ " nullable: true IJsonResponseOfPassengerSegment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerSegment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfThreeDSecureResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ThreeDSecureResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ThreeDSecureResponse: type: object description: "Defines three D secure response.\n " additionalProperties: false properties: redirectUrl: type: string description: "The url to visit for 3DS verification.\n " nullable: true paReq: type: string description: "The 3DS standard PaReq verification token.\n " nullable: true responseUrl: type: string description: "The response url for the bank to use after verification.\n\ \ " nullable: true md: type: string description: "The 3DS standard MD field used for the merchant session tracker.\n\ \ " nullable: true raw: type: string description: "The raw html used for a form post as sent by sky pay.\n \ \ " nullable: true paymentTransactionKey: type: string description: "The payment transaction key.\n " nullable: true threeDSecureVersion: type: string description: "The three d secure version. Indicates the version of 3DS that\ \ was applied during the authentication.\n " nullable: true IJsonResponseOfVoucherInformation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/VoucherInformation' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' VoucherInformation: type: object description: "Voucher information. This model describes a voucher information\ \ after being queried by the voucher code.\n " additionalProperties: false properties: foreignCurrencyCode: type: string description: "The foreign currency code.\n " maxLength: 3 minLength: 0 nullable: true foreignAmount: type: number description: "The amount of foreign currency.\n " format: decimal type: description: "The voucher type.\n " $ref: '#/components/schemas/VoucherType' password: type: string description: "The password for the voucher.\n " nullable: true recordLocator: type: string description: "The record locator associated with the voucher.\n \ \ " maxLength: 12 minLength: 0 nullable: true transactions: type: array description: "The voucher transactions.\n " nullable: true items: $ref: '#/components/schemas/VoucherTransaction' voucherKey: type: string description: "The voucher key.\n " nullable: true reference: type: string description: "The reference number for the voucher.\n " maxLength: 20 minLength: 0 nullable: true configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 nullable: true status: description: "The voucher status.\n " $ref: '#/components/schemas/VoucherStatus' available: type: number description: "The availability count of the voucher.\n " format: decimal firstName: type: string description: "The first name associated with the voucher.\n " maxLength: 64 minLength: 0 nullable: true lastName: type: string description: "The last name associated with the voucher.\n " maxLength: 64 minLength: 0 nullable: true personKey: type: string description: "The person key associated with the voucher.\n " nullable: true voucherIssuanceKey: type: string description: "The voucher issuance key.\n " nullable: true expiration: type: string description: "The voucher expiration date.\n " format: date-time nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of currency.\n " format: decimal calculatedAmount: type: number description: "The total amount of the booking that is payable by the voucher.\n\ \ " format: decimal customerNumber: type: string description: "The customer number associated to the voucher.\n \ \ " nullable: true foreignCalculatedAmount: type: number description: "The total amount of the booking that is payable by the voucher,\n\ converted to a foreign currency specified by the ForeignCalculatededCurrencyCode.\n\ Used if the booking and voucher are in different currencies.\n \ \ " format: decimal foreignCalculatededCurrencyCode: type: string description: "The currency code for used with the ForeignCalculatedAmount\ \ field.\nUsed if the booking and voucher are in different currencies,\ \ this would be the currency code being converted to.\n " nullable: true foreignReversableAmount: type: number description: "Returns the original available amount of the voucher, converted\ \ to a foreign currency.\nUsed if the booking and voucher are in different\ \ currencies.\n " format: decimal nameRestriction: description: "The name restriction for the voucher.\n " $ref: '#/components/schemas/VoucherNameRestriction' redeemableAmount: type: number description: "The total amount of the booking that the voucher can pay for\ \ up to the full amount of the voucher.\n " format: decimal reversableAmount: type: number description: "Returns the original available amount of the voucher.\n \ \ " format: decimal foreignAvailableCurrencyCode: type: string description: "The currency code for used with the ForeignAvailableAmount\ \ field.\nUsed if the booking and voucher are in different currencies,\ \ this\nwould be the currency code being converted to.\n " nullable: true availableAmount: type: number description: "The total amount available on the voucher for use in the currency\ \ that the booking in state is in.\n " format: decimal VoucherType: type: integer description: "Defines the type of voucher.\n \n\n0 = Credit\n1 =\ \ SingleUseCredit\n2 = Service\n3 = SingleUse\n4 = MultiUse\n5 = SingleUseNegativeAdjustment\n\ 6 = PassengerSelect" x-enumNames: - Credit - SingleUseCredit - Service - SingleUse - MultiUse - SingleUseNegativeAdjustment - PassengerSelect enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 VoucherTransaction: type: object description: "The voucher transaction model.\n " additionalProperties: false properties: foreignCurrencyCode: type: string description: "The foreign currency code.\n " maxLength: 3 minLength: 0 nullable: true foreignAmount: type: number description: "The amount of foreign currency.\n " format: decimal currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of currency.\n " format: decimal voucherTransactionKey: type: string description: "The voucher transaction key.\n " nullable: true type: description: "The voucher transaction type.\n " $ref: '#/components/schemas/VoucherTransactionType' recordLocator: type: string description: "The record locator associated with the voucher transaction.\n\ \ " nullable: true VoucherTransactionType: type: integer description: "Defines voucher transaction type.\n \n\n0 = Debit\n\ 1 = Credit\n2 = Void\n3 = Reinstate\n4 = Adjustment\n5 = ExpirationDateChange\n\ 6 = VoucherTypeChange\n7 = VoucherOwnerChange" x-enumNames: - Debit - Credit - Void - Reinstate - Adjustment - ExpirationDateChange - VoucherTypeChange - VoucherOwnerChange enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 VoucherStatus: type: integer description: "Defines the status of a voucher.\n \n\n0 = Available\n\ 1 = Void\n2 = Redeemed\n3 = Expired" x-enumNames: - Available - Void - Redeemed - Expired enum: - 0 - 1 - 2 - 3 VoucherNameRestriction: type: integer description: "Defines how the name on the voucher will be validated.\n \ \ \n\n0 = None\n1 = MustBePassenger\n2 = MustBePassengerOrContact" x-enumNames: - None - MustBePassenger - MustBePassengerOrContact enum: - 0 - 1 - 2 IJsonResponseOfPaymentInformation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PaymentInformation' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PaymentInformation: type: object description: "Defines the extra payment information.\n " additionalProperties: false properties: threeDSecureResponse: description: "The three d secure response after making an initial payment.\n\ \ " nullable: true $ref: '#/components/schemas/ThreeDSecureResponse' directCurrencyConversionOffer: description: "The direct currency conversion offer after making an initial\ \ payment.\n " nullable: true $ref: '#/components/schemas/DirectCurrencyConversionOffer' DirectCurrencyConversionOffer: type: object description: "Defines the direct currency conversion offer.\n " additionalProperties: false properties: dccPaymentTransactionKey: type: string description: "The dcc payment transaction key.\n " nullable: true currencyCode: type: string description: "The currency code converted to.\n " maxLength: 3 minLength: 0 nullable: true rateValue: type: number description: "The conversion rate value.\n " format: decimal amount: type: number description: "The conversion rate amount.\n " format: decimal VoucherPaymentRequest: type: object description: "Model to request a voucher payment.\n " additionalProperties: false required: - referenceCode - paymentMethodCode properties: currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of currency.\n " format: decimal referenceCode: type: string description: "The voucher reference code.\n " maxLength: 20 minLength: 1 paymentMethodCode: type: string description: "The payment method to apply the voucher to. This will default\ \ to primary voucher code.\n " maxLength: 2 minLength: 1 overrideRestrictions: type: boolean description: "Whether to override voucher restrictions.\n " nullable: true IJsonResponseOfIDictionaryOfStringAndPaymentMethod: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: $ref: '#/components/schemas/PaymentMethod' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PaymentMethod: type: object description: "The payment method model.\n " additionalProperties: false required: - paymentMethodCode - name properties: paymentMethodCode: type: string description: "The payment method code for this payment method.\n \ \ " maxLength: 2 minLength: 0 allowDeposit: type: boolean description: "The allow deposit flag for this payment method.\n \ \ " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes\ \ endpoint to verify role based access instead.\n " allowZeroAmount: type: boolean description: "The allow zero amount flag for this payment method.\n \ \ " commissionable: type: boolean description: "The commissionable flag for this payment method.\n \ \ " dccType: description: "The DCC type for this payment method.\n " $ref: '#/components/schemas/DccType' disallowPartialRefund: type: boolean description: "The disallow partial refund flag for this payment method.\n\ \ " feeCode: type: string description: "The fee code for this payment method.\n " maxLength: 6 minLength: 0 nullable: true inActive: type: boolean description: "The inactive flag for this payment method.\n " maxInstallments: type: integer description: "The max installments for this payment method.\n \ \ " name: type: string description: "The name for this payment method.\n " maxLength: 64 minLength: 0 paymentMethodFields: type: object description: "The payment method fields for this payment method.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/PaymentMethodField' paymentMethodType: description: "The payment method type for this payment method.\n \ \ " $ref: '#/components/schemas/PaymentMethodType' paymentRefundType: description: "The payment refund type for this payment method.\n \ \ " $ref: '#/components/schemas/PaymentRefundType' proportionalRefund: type: boolean description: "The proportional refund flag for this payment method.\n \ \ " refundableByAgent: type: boolean description: "The refundable by agent flag for this payment method.\n \ \ " refundCurrencyControl: description: "The refund currency control for this payment method.\n \ \ " $ref: '#/components/schemas/RefundCurrencyControl' restrictionHours: type: integer description: "The hours of restriction for this payment method.\n \ \ " systemControlled: type: boolean description: "The system controlled flag for this payment method.\n \ \ " traceQueueCode: type: string description: "The trace queue code for this payment method.\n \ \ " maxLength: 6 minLength: 0 nullable: true validationRequired: type: boolean description: "The validation required flag for this payment method.\n \ \ " enableDeviceDataCollectionWithJwt: type: boolean description: "Whether device data collection with jwt is enabled.\n \ \ " DccType: type: integer description: "Dynamic Currency Conversion (DCC) types.\n \n\n0 =\ \ None\n1 = ZeroRate\n2 = FullAmount" x-enumNames: - None - ZeroRate - FullAmount enum: - 0 - 1 - 2 PaymentMethodField: type: object description: "The payment method field model.\n " additionalProperties: false required: - paymentMethodFieldCode - name - paymentMethodCode properties: paymentMethodFieldCode: type: string description: "The code for this payment field\n " maxLength: 32 minLength: 0 bookingPaymentField: description: "The field category for this payment field.\n " $ref: '#/components/schemas/BookingPaymentField' name: type: string description: "The name of this payment field\n " maxLength: 64 minLength: 0 ordinal: type: integer description: "The order number for this payment field.\n " paymentMethodCode: type: string description: "The payment method code for this payment field.\n \ \ " maxLength: 2 minLength: 0 paymentMethodType: description: "The payment method type for this payment field.\n \ \ " $ref: '#/components/schemas/PaymentMethodType' persistData: type: boolean description: "The persist data flag for this payment field.\n \ \ " refundUiState: description: "The refund ui state for this payment field.\n " $ref: '#/components/schemas/RefundState' requiredType: description: "The required type for this payment field.\n " $ref: '#/components/schemas/RequiredType' valueMaxLength: type: integer description: "The value max length for this payment field.\n " valueMinLength: type: integer description: "The value min length for this payment field.\n " valueRegEx: type: string description: "The Regular Expression for this payment field.\n \ \ " maxLength: 128 minLength: 0 nullable: true valueType: description: "The value type for this payment field.\n " $ref: '#/components/schemas/ValueType' BookingPaymentField: type: integer description: "This enum represents payment field categories.\n \n\ \n0 = Miscellaneous\n1 = AccountNumber\n2 = Amount\n3 = ExpirationDate\n4\ \ = CurrencyCode\n5 = PaymentText\n6 = PrepaidApprovalCode\n7 = Deposit" x-enumNames: - Miscellaneous - AccountNumber - Amount - ExpirationDate - CurrencyCode - PaymentText - PrepaidApprovalCode - Deposit enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 RefundState: type: integer description: "Enumeration representing the refund ui state.\n \n\n\ 0 = Enabled\n1 = Disabled\n2 = Hidden" x-enumNames: - Enabled - Disabled - Hidden enum: - 0 - 1 - 2 RequiredType: type: integer description: "This enum represents the state of a payment field.\n \ \ \n\n0 = Required\n1 = Optional\n2 = NotAllowed" x-enumNames: - Required - Optional - NotAllowed enum: - 0 - 1 - 2 ValueType: type: integer description: "This enum represents the value type of an input box.\n \ \ \n\n0 = Unknown\n1 = String\n2 = UpperCaseString\n3 = Numeric\n4 = Alphanumeric\n\ 5 = Amount\n6 = Date\n7 = Mod10\n8 = Name\n9 = Address\n10 = State\n11 = Zip\n\ 12 = Country\n13 = City\n14 = Boolean\n15 = Email" x-enumNames: - Unknown - String - UpperCaseString - Numeric - Alphanumeric - Amount - Date - Mod10 - Name - Address - State - Zip - Country - City - Boolean - Email enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 PaymentRefundType: type: integer description: "Enum representing whether or not a payment can be refunded.\n\ \ \n\n0 = NotAllowed\n1 = LineItemLevel\n2 = AccountLevel\n3 =\ \ BookingLevel" x-enumNames: - NotAllowed - LineItemLevel - AccountLevel - BookingLevel enum: - 0 - 1 - 2 - 3 RefundCurrencyControl: type: integer description: "Enum representing the currency control on a refund.\n \ \ \n\n0 = UseCollectedCurrency\n1 = UseQuotedCurrency" x-enumNames: - UseCollectedCurrency - UseQuotedCurrency enum: - 0 - 1 CreditShellRefundRequest: type: object description: "Defines information needed for a credit shell refund.\n \ \ " additionalProperties: false required: - parentPaymentKey - amount - accountTransactionCode - accountType properties: parentPaymentKey: type: string description: "The payment identifier used if this refund is being reversed\ \ from an existing payment to a credit shell.\n " minLength: 1 amount: type: number description: "The amount to apply.\n " format: decimal currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true accountTransactionCode: type: string description: "The account transaction code associated with the refund.\n\ \ " minLength: 1 accountType: description: "The credit shell account type.\n " $ref: '#/components/schemas/CreditShellAccountType' comment: type: string description: "The credit shell refund comment.\n " nullable: true CreditShellAccountType: type: integer description: "Account types used for credit shell refunds.\n \n\n\ 0 = CustomerNumber\n1 = ReservationCredit" x-enumNames: - CustomerNumber - ReservationCredit enum: - 0 - 1 PaymentReversalRequest: type: object description: "Defines information needed for reversing a payment in the state\ \ booking.\n " additionalProperties: false required: - amount - paymentMethodCode properties: parentPaymentKey: type: string description: "The payment identifier used if this refund is being reversed\ \ from an existing payment, which in turn, creates a\nline item refund.\n\ When set to null, a booking level refund is made instead.\n \ \ " nullable: true amount: type: number description: "The amount to apply.\n " format: decimal paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true paymentMethodCode: type: string description: "Payment method code.\n " maxLength: 2 minLength: 1 accountTransactionCode: type: string description: "The account transaction code associated with the account.\n\ \ " nullable: true comment: type: string description: "The payment refund comment.\n " nullable: true IJsonResponseOfIListOfPayment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Payment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPayment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Payment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPaymentAllocations: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PaymentAllocations' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PaymentAllocations: type: object description: "Defines the booking payment allocations.\n " additionalProperties: false properties: recordLocator: type: string description: "The record locator.\n " nullable: true currencyCode: type: string description: "The booking currency code.\n " maxLength: 3 minLength: 0 nullable: true totalAllocationAmount: type: number description: "The total allocation amount.\n " format: decimal paymentAllocationDocuments: type: array description: "The list of payment allocation documents.\n " nullable: true items: $ref: '#/components/schemas/PaymentAllocationDocument' PaymentAllocationDocument: type: object description: "Defines the payment allocation document.\n " additionalProperties: false properties: issuanceDate: type: string description: "The issuance date.\n " format: date-time ticketNumber: type: string description: "The ticket number.\n " maxLength: 14 minLength: 13 nullable: true documentType: type: string description: "The document type.\n " nullable: true passengerKey: type: string description: "The passenger key.\n " nullable: true passengerName: description: "The passengers name.\n " nullable: true $ref: '#/components/schemas/Name' paymentKeys: type: array description: "The list of payment keys allocated to the passenger.\n \ \ " nullable: true items: type: string IJsonResponseOfPagedFindPaymentsByBinResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PagedFindPaymentsByBinResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PagedFindPaymentsByBinResponse: type: object description: "The paged find payments by bank identification number (BIN) response.\n\ \ " additionalProperties: false properties: lastPageKey: type: string description: "The key for the last payment record returned from paged response.\n\ \ " nullable: true totalCount: type: integer description: "The total number of payment records that satisfies the query.\n\ \ " format: int32 paymentRecords: type: object description: "The payment records that matches the query.\n " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/FindBinRangePaymentData' FindBinRangePaymentData: type: object description: "The find payments by bank identification number (BIN) payment\ \ data.\n " additionalProperties: false properties: accountNumber: type: string description: "The account number.\n " nullable: true paymentDate: type: string description: "The date when the payment was made.\n " format: date-time passengerName: description: "The name of the passenger in the booking.\n " nullable: true $ref: '#/components/schemas/Name' departureDate: type: string description: "The departure date and time of the flight in the booking.\n\ \ " format: date-time status: description: "The payment status.\n " $ref: '#/components/schemas/BookingPaymentStatus' recordLocator: type: string description: "The record locator to which the payment belongs.\n \ \ " nullable: true origin: type: string description: "The departure station of flight in the booking.\n \ \ " nullable: true destination: type: string description: "The arrival station of the flight in the booking.\n \ \ " nullable: true AutoAssignRequestv2: type: object description: "Defines the auto assign seat request, v2.\n " additionalProperties: false properties: waiveFee: type: boolean description: "The flag indicating to waive the seat fees if permissions\ \ permit.\n " nullable: true inventoryControl: description: "Indicates the type of hold placed on a unit.\n " nullable: true $ref: '#/components/schemas/UnitInventoryControlType' seatAssignmentMode: description: "The seat assignment mode.\n " nullable: true $ref: '#/components/schemas/SeatAssignmentMode' collectedCurrencyCode: type: string description: "Optional collection currency code. If different from the booking\ \ currency,\nfees in the collected currency will be returned if a currency\ \ conversion configuration exists.\n " maxLength: 3 minLength: 0 nullable: true feePricingMode: description: "Indicates if the seat is to be sold in currency or points.\n\ \ " nullable: true $ref: '#/components/schemas/FeePricingMode' preferences: description: "The list of seat preferences for the primary passenger.\n\ \ " nullable: true $ref: '#/components/schemas/SeatPreferences' seatedNearPrimary: type: array description: "The list of passenger keys for seating assignments near the\ \ primary passenger.\nOnly passengers on the list and the primary passenger\ \ will be assigned\nseats. If the list is empty, seats will be assigned\ \ to all passengers.\n " nullable: true items: type: string changeOfGaugeDetails: description: "The change of gauge details.\n " nullable: true $ref: '#/components/schemas/ChangeOfGaugeDetails' primaryPassengerKey: type: string description: "The key for the primary passenger.\n " nullable: true SeatAssignmentMode: type: integer description: "Represents the seat assignment mode.\n \n\n0 = AutoDetermine\n\ 1 = PreSeatAssignment\n2 = WebCheckIn" x-enumNames: - AutoDetermine - PreSeatAssignment - WebCheckIn enum: - 0 - 1 - 2 ChangeOfGaugeDetails: type: object description: "Defines the change of gauge details.\n " additionalProperties: false properties: equipmentType: type: string description: "The equipment type of the legs to be auto-assigned seats.\ \ This is used for change\nof gauge (meaning that the legs have different\ \ equipment) and works in conjunction\nwith EquipmentTypeSuffix. If both\ \ are null or empty, or segment is not change of gauge,\nseats will be\ \ assigned to all legs. Else, seats will be assigned to legs matching\n\ this EquipmentType and the EquipmentTypeSuffix.\n " nullable: true equipmentTypeSuffix: type: string description: "The equipment type suffix of the legs to be auto-assigned\ \ seats. This is used for\nchange of gauge (meaning that the legs have\ \ different equipment) and works in\nconjunction with EquipmentType. If\ \ both are null or empty, or segment is not\nchange of gauge, seats will\ \ be assigned to all legs. Else, seats will be assigned\nto legs matching\ \ the EquipmentType and this EquipmentTypeSuffix.\n " nullable: true AutoAssignRequest: type: object description: "Defines the auto assign seat request.\n " additionalProperties: false properties: waiveFee: type: boolean description: "The flag indicating to waive the seat fees if permissions\ \ permit.\n " nullable: true inventoryControl: description: "Indicates the type of hold placed on a unit.\n " nullable: true $ref: '#/components/schemas/UnitInventoryControlType' seatAssignmentMode: description: "The seat assignment mode.\n " nullable: true $ref: '#/components/schemas/SeatAssignmentMode' collectedCurrencyCode: type: string description: "Optional collection currency code. If different from the booking\ \ currency,\nfees in the collected currency will be returned if a currency\ \ conversion configuration exists.\n " maxLength: 3 minLength: 0 nullable: true feePricingMode: description: "Indicates if the seat is to be sold in currency or points.\n\ \ " nullable: true $ref: '#/components/schemas/FeePricingMode' preferences: description: "The list of seat preferences for the primary passenger.\n\ \ " nullable: true $ref: '#/components/schemas/SeatPreferences' seatedNearPrimary: type: array description: "The list of passenger keys for seating assignments near the\ \ primary passenger.\nOnly passengers on the list and the primary passenger\ \ will be assigned\nseats. If the list is empty, seats will be assigned\ \ to all passengers.\n " nullable: true items: type: string changeOfGaugeDetails: description: "The change of gauge details.\n " nullable: true $ref: '#/components/schemas/ChangeOfGaugeDetails' ModifySegmentStatus: type: integer description: "The status in which the segment can be changed to.\n \ \ \n\n0 = UnknownStatus\n1 = NoActionTaken\n2 = UnableToConfirmSegment\n\ 3 = HeldConfirmed\n4 = HeldCancelled\n5 = ConfirmedTimeChange" x-enumNames: - UnknownStatus - NoActionTaken - UnableToConfirmSegment - HeldConfirmed - HeldCancelled - ConfirmedTimeChange enum: - 0 - 1 - 2 - 3 - 4 - 5 PassengerSsrKey: type: object description: "The model for the data needed to identify a passenger ssr key.\n\ \ " additionalProperties: false properties: ssrDuration: description: "The length of the Ssr duration.\n " $ref: '#/components/schemas/SsrDurationType' ssrCode: type: string description: "The passenger SSR code.\n " maxLength: 4 minLength: 0 nullable: true passengerKey: type: string description: "The unique passenger key.\n " nullable: true ssrNumber: type: integer description: "The passenger SSR number.\n " maximum: 32767.0 minimum: 0.0 nullable: true market: description: "The market for either the leg or segment depending on the\ \ Ssr type.\n " nullable: true $ref: '#/components/schemas/MarketInformation' IJsonResponseOfIListOfPassengerSsr: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerSsr' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerSsr: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerSsr' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfDateTime: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: string description: "The payload data.\n " format: date-time errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TicketRequest: type: object description: "A ticket request.\n " additionalProperties: false properties: ticketNumber: type: string description: "The ticket number.\n " maxLength: 14 minLength: 13 nullable: true infantTicketNumber: type: string description: "The infant ticket number.\n " maxLength: 14 minLength: 13 nullable: true ticketIndicator: description: "The ticket indicator.\n " $ref: '#/components/schemas/TicketIndicatorCode' ticketStatus: description: "The ticket status.\n " $ref: '#/components/schemas/TicketStatusCode' IJsonResponseOfTravelDocumentRequirements: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/TravelDocumentRequirements' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TravelDocumentRequirements: type: object description: "Defines the type of sale values.\n " additionalProperties: false properties: atLeastOneDocumentRequired: type: boolean description: "True if at least one travel document code in the travel document\ \ type codes list\nis required.\n " travelDocumentTypeCodes: type: array description: "The combined list of acceptable travel document type codes.\n\ \ " nullable: true items: type: string IJsonResponseOfOneTimeTravelNotificationv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/OneTimeTravelNotificationv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' OneTimeTravelNotificationv2: type: object description: "A one time travel notification.\n " additionalProperties: false properties: subscriptionNumber: type: string description: "The subscription number.\n " nullable: true events: type: array description: "The list of one time travel notification events.\n \ \ " nullable: true items: $ref: '#/components/schemas/OneTimeNotificationEvent' timedEvents: type: array description: "The list of travel notification timed events.\n \ \ " nullable: true items: $ref: '#/components/schemas/NotificationTimedEvent' marketInformation: description: "The market information to add a notification to.\n \ \ " nullable: true $ref: '#/components/schemas/MarketInformation' cultureCode: type: string description: "The culture code.\n " nullable: true notificationDestination: description: "The notification destination.\n " nullable: true $ref: '#/components/schemas/NotificationDestination' deviceName: type: string description: "The name of the device for the push notification.\n \ \ " nullable: true expirationDate: type: string description: "The expiration date.\n " format: date-time nullable: true IJsonResponseOfIListOfVoucherConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/VoucherConfiguration' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' VoucherConfiguration: type: object description: "The voucher configuration model.\n " additionalProperties: false required: - configurationCode - name - description - type - issuanceType - expirationType properties: configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 note: type: string description: "The voucher configuration note.\n " nullable: true name: type: string description: "The voucher configuration name.\n " maxLength: 64 minLength: 0 description: type: string description: "The voucher configuration description.\n " maxLength: 128 minLength: 0 type: description: "The voucher type.\n " $ref: '#/components/schemas/VoucherType' issuanceType: description: "The issuance type.\n " $ref: '#/components/schemas/IssuanceType' usageTypes: type: array description: "The voucher usage types.\n " nullable: true items: $ref: '#/components/schemas/VoucherUsageType' tripType: description: "The voucher trip type.\n " $ref: '#/components/schemas/VoucherTripType' expirationControl: description: "The voucher expiration control.\n " $ref: '#/components/schemas/VoucherExpirationControl' expirationType: description: "The voucher expiration type.\n " $ref: '#/components/schemas/VoucherExpirationType' expirationDays: type: integer description: "The voucher expiration days.\n " amountControl: description: "The voucher amount control.\n " $ref: '#/components/schemas/AmountControl' calculatedAmountControl: description: "The voucher calculated amount control.\n " $ref: '#/components/schemas/CalculatedAmountControl' maximumPassengers: type: integer description: "The voucher maximum passenger total.\n " maximum: 32767.0 minimum: 1.0 maximumVouchersPerBooking: type: integer description: "The voucher maximum number of vouchers per booking.\n \ \ " travelDowRestriction: type: array description: "The voucher day of week travel restrictions.\n " nullable: true items: $ref: '#/components/schemas/DayOfWeek' nameRestriction: description: "The voucher name restriction.\n " $ref: '#/components/schemas/VoucherNameRestriction' isRecordLocatorRequired: type: boolean description: "The flag to indicate if a record locator is required.\n \ \ " isCustomerNumberRequired: type: boolean description: "The flag to indicate if a customer number is required.\n \ \ " nextReferenceNumber: type: integer description: "The next reference number for the voucher configuration.\n\ \ " format: int64 maximumAmountIsPerPassenger: type: boolean description: "Flag to indicate if the maximum amount is per passenger or\ \ not.\n " calculatedPercentage: type: number description: "The calculated percentage.\n " format: decimal issuanceControl: description: "The voucher issuance control.\n " $ref: '#/components/schemas/VoucherIssuanceControl' fareClasses: type: array description: "The voucher configuration fare classes.\n " nullable: true items: $ref: '#/components/schemas/VoucherConfigurationFareClass' marketRestrictions: type: array description: "The voucher configuration market restrictions.\n \ \ " nullable: true items: $ref: '#/components/schemas/VoucherMarketRestriction' travelRestrictions: type: array description: "The voucher configuration travel restrictions.\n \ \ " nullable: true items: $ref: '#/components/schemas/VoucherTravelRestriction' expiration: type: string description: "The voucher expiration date.\n " format: date-time currencyCode: type: string description: "The voucher currency code.\n " maxLength: 3 minLength: 0 nullable: true maximumAmount: type: number description: "The maximum voucher amount.\n " format: decimal createdDate: type: string description: "The voucher creation date.\n " format: date-time enabled: type: boolean description: "Indicates if the voucher is enabled or disabled.\n \ \ " IssuanceType: type: integer description: "The issuance type.\n \n\n0 = Individual\n1 = Batch\n\ 2 = FlightBatch\n3 = HighVolumeBatch\n4 = OdBatch" x-enumNames: - Individual - Batch - FlightBatch - HighVolumeBatch - OdBatch enum: - 0 - 1 - 2 - 3 - 4 VoucherUsageType: type: integer description: "Voucher usage type specifies what parts of a booking this voucher\ \ can pay for.\n \n\n0 = None\n1 = Fares\n2 = Taxes\n3 = TravelFees\n\ 4 = ServiceFees\n5 = PenaltyFees\n6 = SsrFees\n7 = NonFlightServiceFees\n\ 8 = UpgradeFees\n9 = SeatFees\n10 = SpoilageFees\n11 = NameChangeFees\n12\ \ = ConvenienceFees\n13 = Car\n14 = Hotel\n15 = Insurance\n16 = Activities" x-enumNames: - None - Fares - Taxes - TravelFees - ServiceFees - PenaltyFees - SsrFees - NonFlightServiceFees - UpgradeFees - SeatFees - SpoilageFees - NameChangeFees - ConvenienceFees - Car - Hotel - Insurance - Activities enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 VoucherTripType: type: integer description: "The types of trips a voucher could be user for.\n \n\ \n0 = Any\n1 = OneWay\n2 = RoundTrip\n3 = None" x-enumNames: - Any - OneWay - RoundTrip - None enum: - 0 - 1 - 2 - 3 VoucherExpirationControl: type: integer description: "The voucher expiration control.\n \n\n0 = None\n1 =\ \ Fixed\n2 = FixedAtIssuance\n3 = Calculated" x-enumNames: - None - Fixed - FixedAtIssuance - Calculated enum: - 0 - 1 - 2 - 3 VoucherExpirationType: type: integer description: "The voucher expiration type.\n \n\n0 = TravelBy\n1\ \ = TravelCompleteBy\n2 = BookingBy" x-enumNames: - TravelBy - TravelCompleteBy - BookingBy enum: - 0 - 1 - 2 AmountControl: type: integer description: "The amount control enumeration.\n \n\n0 = Fixed\n1\ \ = FixedAtIssuance\n2 = Calculated" x-enumNames: - Fixed - FixedAtIssuance - Calculated enum: - 0 - 1 - 2 CalculatedAmountControl: type: integer description: "Represents the different types of service a voucher could be used\ \ for.\n \n\n0 = Default\n1 = Fares\n2 = FaresPlusTaxes\n3 = FaresTaxesAndFees\n\ 4 = FaresTaxesFeesAndOtherServices" x-enumNames: - Default - Fares - FaresPlusTaxes - FaresTaxesAndFees - FaresTaxesFeesAndOtherServices enum: - 0 - 1 - 2 - 3 - 4 DayOfWeek: type: integer description: "Defines the day of the week with none as an option.\n \ \ \n\n0 = None\n1 = Monday\n2 = Tuesday\n3 = Wednesday\n4 = Thursday\n\ 5 = Friday\n6 = Saturday\n7 = Sunday" x-enumNames: - None - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 VoucherIssuanceControl: type: integer description: "The voucher issuance control enumeration.\n \n\n0 =\ \ IssuedToPassengers\n1 = IssuedToContact" x-enumNames: - IssuedToPassengers - IssuedToContact enum: - 0 - 1 VoucherConfigurationFareClass: type: object description: "The voucher configuration model.\n " additionalProperties: false properties: configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 nullable: true classOfService: type: string description: "The voucher configuration fare class of service.\n \ \ " maxLength: 8 minLength: 0 nullable: true VoucherMarketRestriction: type: object description: "The voucher market restriction model.\n " additionalProperties: false properties: voucherConfigurationCode: type: string description: "The voucher configuration code.\n " nullable: true sequence: type: integer description: "The sequence number of the voucher restriction.\nWhen updating\ \ the restriction, you will need to specify the sequence number in order\ \ to properly update\nthe associated restriction.\nIn order to add a restriction,\ \ the sequence number on needs to\nbe set to `-1` to indicate to NewSkies\ \ that it is an added restriction.\n " restrictionType: description: "The market restriction type.\n " $ref: '#/components/schemas/MarketRestrictionType' directionality: description: "The directionality of the voucher market restriction.\n \ \ " $ref: '#/components/schemas/Directionality' regionType: description: "The region type.\n " $ref: '#/components/schemas/RegionType' regionCode: type: string description: "The region code.\n " nullable: true travelRegionType: description: "The travel region type.\n " $ref: '#/components/schemas/RegionType' travelRegionCode: type: string description: "The travel region code.\n " nullable: true MarketRestrictionType: type: integer description: "The market restriction type enumeration.\n \n\n0 =\ \ MustBeOne\n1 = MustNot" x-enumNames: - MustBeOne - MustNot enum: - 0 - 1 VoucherTravelRestriction: type: object description: "The voucher configuration model.\n " additionalProperties: false properties: voucherConfigurationCode: type: string description: "The voucher configuration code.\n " nullable: true sequence: type: integer description: "The sequence number of the voucher restriction.\nWhen updating\ \ the restriction, you will need to specify the sequence number in order\ \ to properly update\nthe associated restriction.\nIn order to add a restriction,\ \ the sequence number on needs to\nbe set to `-1` to indicate to NewSkies\ \ that it is an added restriction.\n " restrictionType: description: "The travel restriction type.\n " $ref: '#/components/schemas/TravelRestrictionType' initialTravelDate: type: string description: "The beginning travel date.\n " format: date-time nullable: true endTravelDate: type: string description: "The ending travel date.\n " format: date-time nullable: true TravelRestrictionType: type: integer description: "The travel restriction type.\n \n\n0 = Default\n1 =\ \ Blackout\n2 = Season" x-enumNames: - Default - Blackout - Season enum: - 0 - 1 - 2 IJsonResponseOfVoucherConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/VoucherConfiguration' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' VoucherConfigurationRequest: type: object description: "The voucher configuration request model.\n " deprecated: true x-deprecatedMessage: 4.5.2 - Please use VoucherConfigurationRequestv2 additionalProperties: false required: - configurationCode - name - description - expirationDate - currencyCode - note properties: configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 name: type: string description: "The voucher configuration name.\n " maxLength: 64 minLength: 0 description: type: string description: "The voucher configuration description.\n " maxLength: 128 minLength: 0 type: description: "The voucher type.\n " nullable: true $ref: '#/components/schemas/VoucherType' issuanceType: description: "The issuance type.\n " nullable: true $ref: '#/components/schemas/IssuanceType' voucherUsageType: description: "The voucher usage types.\n " $ref: '#/components/schemas/VoucherUsageType' tripType: description: "The voucher trip type.\n " $ref: '#/components/schemas/VoucherTripType' expirationControl: description: "The voucher expiration control.\n " $ref: '#/components/schemas/VoucherExpirationControl' expirationType: description: "The voucher expiration type.\n " nullable: true $ref: '#/components/schemas/VoucherExpirationType' expirationDate: type: string description: "The expiration date.\n " format: date-time minLength: 1 expirationDays: type: integer description: "The voucher expiration days.\n " currencyCode: type: string description: "The voucher currency code.\n " maxLength: 3 minLength: 0 amountControl: description: "The voucher amount control.\n " $ref: '#/components/schemas/AmountControl' calculatedAmountControl: description: "The voucher calculated amount control.\n " $ref: '#/components/schemas/CalculatedAmountControl' maximumAmount: type: number description: "The maximum voucher amount.\n " format: decimal maximumPassengers: type: integer description: "The voucher maximum passenger total.\n " maximum: 32767.0 minimum: 1.0 maximumVouchersPerBooking: type: integer description: "The voucher maximum number of vouchers per booking.\n \ \ " travelDayOfWeekRestriction: type: array description: "The voucher day of week travel restrictions.\n " nullable: true items: $ref: '#/components/schemas/DayOfWeek' nameRestriction: description: "The voucher name restriction.\n " $ref: '#/components/schemas/VoucherNameRestriction' voucherRequirements: description: "The voucher requirements.\n " $ref: '#/components/schemas/VoucherRequirements' nextReferenceNumber: type: integer description: "The next reference number for the voucher configuration.\n\ \ " format: int64 note: type: string description: "The voucher configuration note.\n " minLength: 1 maximumAmountIsPerPassenger: type: boolean description: "Flag to indicate if the maximum amount is per passenger or\ \ not.\n " calculatedPercentage: type: number description: "The calculated percentage.\n " format: decimal issuanceControl: description: "The voucher issuance control.\n " $ref: '#/components/schemas/VoucherIssuanceControl' enableVoucherAdjustments: type: boolean description: "Enables voucher adjustments.\n " restrictFlightBatchIssuance: description: "The flight batch issuance restrictions.\n " $ref: '#/components/schemas/RestrictFlightBatchIssuance' voucherUsageBaseFeeType: description: "The voucher usage base fee type.\n " $ref: '#/components/schemas/VoucherUsageBaseFeeType' issueToRevenuePassengersOnly: type: boolean description: "Enables Issuance to revenue passengers only.\n " fareClasses: type: array description: "The voucher configuration fare classes.\n " nullable: true items: $ref: '#/components/schemas/VoucherConfigurationFareClass' marketRestrictions: type: array description: "The voucher configuration market restrictions.\n \ \ " nullable: true items: $ref: '#/components/schemas/VoucherMarketRestriction' travelRestrictions: type: array description: "The voucher configuration travel restrictions.\n \ \ " nullable: true items: $ref: '#/components/schemas/VoucherTravelRestriction' enabled: type: boolean description: "Indicates if the voucher is enabled or disabled.\n \ \ " nullable: true VoucherRequirements: type: integer description: "The voucher requirements enumeration.\n \n\n0 = None\n\ 1 = RecordLocator\n2 = CustomerNumber\n3 = Both" x-enumNames: - None - RecordLocator - CustomerNumber - Both enum: - 0 - 1 - 2 - 3 RestrictFlightBatchIssuance: type: integer description: "The restrict flight batch issuance enumeration\n \n\ \n0 = All\n1 = Confirmed\n2 = ConfirmedAndPaidRequired" x-enumNames: - All - Confirmed - ConfirmedAndPaidRequired enum: - 0 - 1 - 2 VoucherUsageBaseFeeType: type: integer description: "Voucher usage type specifies whether the voucher can be used for\ \ included taxes of non-fare components (e.g. SSR\nfees).\n \n\n\ 0 = None\n1 = BaseFeeOnly" x-enumNames: - None - BaseFeeOnly enum: - 0 - 1 VoucherConfigurationDeleteRequest: type: object description: "The voucher configuration delete request model.\n " additionalProperties: false required: - configurationCode - expirationDate properties: configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 expirationDate: type: string description: "The expiration date.\n " format: date-time minLength: 1 IJsonResponseOfVoucher: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Voucher' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Voucher: type: object description: "The voucher model.\n " additionalProperties: false properties: voucherKey: type: string description: "The voucher key.\n " nullable: true reference: type: string description: "The reference number for the voucher.\n " maxLength: 20 minLength: 0 nullable: true configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 nullable: true status: description: "The voucher status.\n " $ref: '#/components/schemas/VoucherStatus' available: type: number description: "The availability count of the voucher.\n " format: decimal firstName: type: string description: "The first name associated with the voucher.\n " maxLength: 64 minLength: 0 nullable: true lastName: type: string description: "The last name associated with the voucher.\n " maxLength: 64 minLength: 0 nullable: true personKey: type: string description: "The person key associated with the voucher.\n " nullable: true voucherIssuanceKey: type: string description: "The voucher issuance key.\n " nullable: true expiration: type: string description: "The voucher expiration date.\n " format: date-time nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of currency.\n " format: decimal foreignCurrencyCode: type: string description: "The foreign currency code.\n " maxLength: 3 minLength: 0 nullable: true foreignAmount: type: number description: "The amount of foreign currency.\n " format: decimal type: description: "The voucher type.\n " $ref: '#/components/schemas/VoucherType' password: type: string description: "The password for the voucher.\n " nullable: true recordLocator: type: string description: "The record locator associated with the voucher.\n \ \ " maxLength: 12 minLength: 0 nullable: true transactions: type: array description: "The voucher transactions.\n " nullable: true items: $ref: '#/components/schemas/VoucherTransaction' IJsonResponseOfVoucherReference: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/VoucherReference' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' VoucherReference: type: object description: "The voucher model.\n " additionalProperties: false properties: foreignCurrencyCode: type: string description: "The foreign currency code.\n " maxLength: 3 minLength: 0 nullable: true foreignAmount: type: number description: "The amount of foreign currency.\n " format: decimal type: description: "The voucher type.\n " $ref: '#/components/schemas/VoucherType' password: type: string description: "The password for the voucher.\n " nullable: true recordLocator: type: string description: "The record locator associated with the voucher.\n \ \ " maxLength: 12 minLength: 0 nullable: true transactions: type: array description: "The voucher transactions.\n " nullable: true items: $ref: '#/components/schemas/VoucherTransaction' voucherKey: type: string description: "The voucher key.\n " nullable: true reference: type: string description: "The reference number for the voucher.\n " maxLength: 20 minLength: 0 nullable: true configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 nullable: true status: description: "The voucher status.\n " $ref: '#/components/schemas/VoucherStatus' available: type: number description: "The availability count of the voucher.\n " format: decimal firstName: type: string description: "The first name associated with the voucher.\n " maxLength: 64 minLength: 0 nullable: true lastName: type: string description: "The last name associated with the voucher.\n " maxLength: 64 minLength: 0 nullable: true personKey: type: string description: "The person key associated with the voucher.\n " nullable: true voucherIssuanceKey: type: string description: "The voucher issuance key.\n " nullable: true expiration: type: string description: "The voucher expiration date.\n " format: date-time nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of currency.\n " format: decimal createdDate: type: string description: "The date when the voucher was created.\n " format: date-time IJsonResponseOfVouchersSummaryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/VouchersSummaryResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' VouchersSummaryResponse: type: object description: "The voucher by date search response item.\n " additionalProperties: false properties: lastPageKey: type: string description: "The key for the last item returned from paging.\n \ \ " nullable: true vouchers: type: array description: "The collection of vouchers.\n " nullable: true items: $ref: '#/components/schemas/VoucherSummary' VoucherSummary: type: object description: "The voucher summary model.\n " additionalProperties: false properties: voucherKey: type: string description: "The unique identifier for the voucher.\n " nullable: true reference: type: string description: "The voucher reference.\n " maxLength: 20 minLength: 0 nullable: true recordLocator: type: string description: "The record locator associated with the voucher.\n \ \ " maxLength: 12 minLength: 0 nullable: true note: type: string description: "The optional note associated with the voucher.\n \ \ " nullable: true amount: type: number description: "The amount of the voucher.\n " format: decimal expiration: type: string description: "The voucher's expiration.\n " format: date-time nullable: true VoucherUpdateRequestv2: type: object description: "The voucher update request.\n " additionalProperties: false properties: status: description: "The status to update the voucher to.\n " nullable: true $ref: '#/components/schemas/VoucherStatusUpdate' type: description: "The voucher type to update the voucher to.\n " nullable: true $ref: '#/components/schemas/VoucherUpdateType' expirationDate: type: string description: "The expiration date to update the voucher to.\n \ \ " format: date-time nullable: true VoucherStatusUpdate: type: integer description: "An enumeration to indicate what status the voucher should\nbe\ \ changed to.\n \n\n0 = Reinstate\n1 = Void" x-enumNames: - Reinstate - Void enum: - 0 - 1 VoucherUpdateType: type: integer description: "Defines the type of voucher that can be updated to.\n \ \ \n\n1 = SingleUseCredit\n3 = SingleUse\n4 = MultiUse\n5 = SingleUseNegativeAdjustment\n\ 6 = PassengerSelect" x-enumNames: - SingleUseCredit - SingleUse - MultiUse - SingleUseNegativeAdjustment - PassengerSelect enum: - 1 - 3 - 4 - 5 - 6 VoucherOwnerUpdateRequest: type: object description: "The voucher owner update request.\n " additionalProperties: false properties: personKey: type: string description: "The person key to update to as the voucher owner. This can\ \ be retrieved via GET /api/nsk/v2/persons.\n " nullable: true firstName: type: string description: "The first name to update to as the voucher owner.\nThis must\ \ match the name assigned to the person when passing in a personKey. If\ \ it does not match, it will\nbe overriden with the first name associated\ \ with the person key.\nIf not populated, will default to the name associated\ \ with the person key.\nIf you only want to set the name, and it's not\ \ one associated with a personKey, then you\ncan pass this in without\ \ a personKey, and it will be set accordingly.\n " maxLength: 64 minLength: 0 nullable: true lastName: type: string description: "The last name to update to as the voucher owner.\nThis must\ \ match the name assigned to the person when passing in a personKey. If\ \ it does not match, it will\nbe overriden with the first name associated\ \ with the person key.\nIf not populated, will default to the name associated\ \ with the person key.\nIf you only want to set the name, and it's not\ \ one associated with a personKey, then you\ncan pass this in without\ \ a personKey, and it will be set accordingly.\n " maxLength: 64 minLength: 0 nullable: true VoucherIssuanceRequest: type: object description: "The voucher issuance request model.\n " additionalProperties: false required: - configurationCode - issuanceReasonCode properties: configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 issuanceReasonCode: type: string description: "The voucher issuance reason code.\n " maxLength: 4 minLength: 0 note: type: string description: "The voucher issuance note.\n " maxLength: 256 minLength: 0 nullable: true market: description: "Market details associated with the voucher issuance.\n \ \ " nullable: true $ref: '#/components/schemas/VoucherMarketInformation' expiration: type: string description: "The voucher expiration date.\n " format: date-time nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of currency.\n " format: decimal recordLocator: type: string description: "The record locator.\n " maxLength: 12 minLength: 0 nullable: true firstName: type: string description: "The passenger's first name.\n " maxLength: 64 minLength: 0 nullable: true lastName: type: string description: "The passenger's last name.\n " maxLength: 64 minLength: 0 nullable: true personKey: type: string description: "The person key.\n " nullable: true quantity: type: integer description: "The number of vouchers to issue.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 customerNumber: type: string description: "The customer number.\n " maxLength: 20 minLength: 0 nullable: true sendFiles: type: boolean description: "Decides whether to send reference files over ftp for a HighVolumeBatch\ \ of vouchers.\n " ssrCode: type: string description: "The SSR filter value in this object.\n " maxLength: 4 minLength: 0 nullable: true VoucherMarketInformation: type: object description: "The voucher market request model.\n " additionalProperties: false required: - destination - origin - departureDate - identifier - carrierCode properties: destination: type: string description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 origin: type: string description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 departureDate: type: string description: "The departure date.\n " format: date-time minLength: 1 identifier: type: string description: "The unique transportation identifier.\n " maxLength: 4 minLength: 0 carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 opSuffix: type: string description: "The op suffix.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 nullable: true IJsonResponseOfVoucherIssuance: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/VoucherIssuance' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' VoucherIssuance: type: object description: "The voucher issuance model.\n " additionalProperties: false required: - configurationCode - issuanceReasonCode properties: configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 issuanceReasonCode: type: string description: "The voucher issuance reason code.\n " maxLength: 4 minLength: 0 note: type: string description: "The voucher issuance note.\n " maxLength: 256 minLength: 0 nullable: true market: description: "Market details associated with the voucher issuance.\n \ \ " nullable: true $ref: '#/components/schemas/VoucherMarketInformation' expiration: type: string description: "The voucher expiration date.\n " format: date-time nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of currency.\n " format: decimal voucherIssuanceKey: type: string description: "The voucher issuance key.\n " nullable: true PassiveSegmentRequest: type: object description: "Passive segment request represents the data that will be added\ \ as a passive segment on a booking.\n " additionalProperties: false required: - carrierCode - flightNumber - classOfService - arrivalTime - departureTime - origin - destination properties: carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 flightNumber: type: string description: "The flight number.\n " maxLength: 4 minLength: 1 opSuffix: type: string description: "The op suffix.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 totalPassengers: type: integer description: "The total number of passengers.\n " nullable: true classOfService: type: string description: "The class of service.\n " maxLength: 8 minLength: 0 arrivalTime: type: string description: "The arrival date.\n " format: date-time minLength: 1 departureTime: type: string description: "The departure date.\n " format: date-time minLength: 1 origin: type: string description: "The origin station.\n " maxLength: 3 minLength: 0 destination: type: string description: "The destination station.\n " maxLength: 3 minLength: 0 TripContactsRequest: type: object description: "Trip contacts request represents the data needed to sell a contacts-only\ \ booking.\n " additionalProperties: false required: - contacts properties: contacts: type: array description: "The contacts for the new booking.\n " items: $ref: '#/components/schemas/Contact' PassengerRequest: type: object description: "Defines the passenger request details.\n " additionalProperties: false required: - passengerTypeCode properties: customerNumber: type: string description: "The passenger customer number.\n " maxLength: 20 minLength: 0 nullable: true name: description: "The passenger's name.\n " nullable: true $ref: '#/components/schemas/Name' discountCode: type: string description: "The discount code associated with the passenger type.\n \ \ " maxLength: 8 minLength: 0 nullable: true program: description: "The passenger programs.\n " nullable: true $ref: '#/components/schemas/PassengerProgram' info: description: "Additional passenger information.\n " nullable: true $ref: '#/components/schemas/PassengerInformation' travelDocuments: type: array description: "Travel Documents.\n " nullable: true items: $ref: '#/components/schemas/TravelDocumentCreateRequest' addresses: type: array description: "The passengers addresses.\n " nullable: true items: $ref: '#/components/schemas/PassengerAddress' infant: description: "The optional infant associated with this passenger.\n \ \ " nullable: true $ref: '#/components/schemas/Infant' passengerTypeCode: type: string description: "The passenger type code.\n " minLength: 1 TravelDocumentCreateRequest: type: object description: "Defines a create travel documents request.\n " additionalProperties: false required: - documentTypeCode properties: birthCountry: type: string description: "The BirthCountry property.\n " nullable: true name: description: "The Name property.\n " nullable: true $ref: '#/components/schemas/Name' nationality: type: string description: "The Nationality property.\n " maxLength: 2 minLength: 0 nullable: true expirationDate: type: string description: "The date when this travel document expires.\n " format: date-time nullable: true number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 nullable: true issuedDate: type: string description: "The date this travel document was issued.\n " format: date-time nullable: true gender: description: "The travel document holder's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true declaredGender: type: string description: "The travel document holder's declared gender.\nThis will override\ \ the gender field on passenger or person POST, PUT, and PATCH requests.\n\ Note: Any value other than \"F\" will cause gender to be updated to Male\ \ by default to support compatibility with\nother systems.\nAdditionally\ \ you cannot change the declared gender and gender fields at the same\ \ time as declared gender\nwill override any gender field value regardless\ \ of the value passed in.\n " maxLength: 2 minLength: 0 nullable: true placeOfBirth: type: string description: "Represents the place of birth. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, numbers,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true placeOfIssue: type: string description: "Represents the place of issue. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: string description: "The issuer code for the travel document (country code).\n\ \ " maxLength: 3 minLength: 0 nullable: true Infant: type: object description: "Model representing an infant.\n " additionalProperties: false properties: dateOfBirth: type: string description: "The date of birth of the infant.\n " format: date-time nullable: true gender: description: "The gender of the passenger.\n " nullable: true $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " nullable: true $ref: '#/components/schemas/Name' declaredGender: type: string description: "The infant's declared gender. A value of \"F\" is mapped to\ \ a female binary gender. All other values will be\nmapped to a male binary\ \ gender.\n " maxLength: 2 minLength: 0 nullable: true nationality: type: string description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 nullable: true residentCountry: type: string description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 nullable: true BookingSellRequest: type: object description: "Trip sell request represents the data needed to sell journeys\ \ to a booking.\n " additionalProperties: false required: - passengers - currencyCode properties: journeys: description: "The journey information.\n " nullable: true $ref: '#/components/schemas/JourneySellRequest' contact: description: "The primary contact.\n " nullable: true $ref: '#/components/schemas/ContactRequest' passengers: type: array description: "The list of passengers.\n " items: $ref: '#/components/schemas/BookingPassengerRequest' residentCountry: type: string description: "The acting resident country.\n " maxLength: 2 minLength: 0 nullable: true currencyCode: type: string description: "The desired currency code.\n " maxLength: 3 minLength: 1 promotionCode: type: string description: "The promo code to apply.\n " maxLength: 8 minLength: 0 nullable: true sourceOrganization: type: string description: "The acting source organization code.\n " maxLength: 10 minLength: 0 nullable: true loyalty: description: "Controls whether to use monetary fares, points-based fares,\ \ or both.\nDefaults to monetary only.\n " nullable: true $ref: '#/components/schemas/TripLoyaltyFilter' serviceBundleCodes: type: array description: "Optional list of bundle codes from a specific fare of a flight\ \ to be added to the booking if `ApplyServiceBundle`\nis set to `Yes`\ \ or `Copy`.\n " nullable: true items: type: string applyServiceBundle: description: "Determines whether to sell bundles in the booking. Can also\ \ be used for cancel or rebook situations.\n " nullable: true $ref: '#/components/schemas/ApplyServiceBundle' JourneySellRequest: type: object description: "Journey request represents the trip sell request but with only\ \ information needed for a booking sell.\n " additionalProperties: false required: - keys properties: keys: type: array description: "The list of selected sell keys to be added to the booking.\n\ \ " items: $ref: '#/components/schemas/SellKey' preventOverlap: type: boolean description: "Used to explicitly control support for flight overlaps. It\ \ works together with the \u2018Allow Sell of Flight Overlap\u2019\nrole\ \ setting. Overlaps will be allowed only when PreventOverlaps is FALSE\ \ and the user has permissions to sell\noverlaps.\n " nullable: true suppressPassengerAgeValidation: type: boolean description: "Flag indicating if passenger and infant age validation will\ \ be skipped.\n " nullable: true SellKey: type: object description: "Sell key represents the journey and the fare sell keys to combine\ \ to what journey and fare will be sold.\n " additionalProperties: false required: - journeyKey - fareAvailabilityKey properties: journeyKey: type: string description: "The journey sell key.\n " minLength: 1 fareAvailabilityKey: type: string description: "The fare sell key.\n " minLength: 1 standbyPriorityCode: type: string description: "The stand by priority code.\n " nullable: true inventoryControl: description: "The reserving inventory action of the journey once sold by\ \ the system.\n " nullable: true $ref: '#/components/schemas/InventoryControlType' BookingPassengerRequest: type: object description: "Defines the the passenger and associated ssr request.\n \ \ " additionalProperties: false required: - passenger properties: passenger: description: "The passenger information.\n " $ref: '#/components/schemas/PassengerRequest' discountCode: type: string description: "The passenger discount code.\n " maxLength: 4 minLength: 0 nullable: true ssrs: type: array description: "The ssrs to initially add.\n " nullable: true items: $ref: '#/components/schemas/JourneySsrRequest' JourneySsrRequest: type: object description: "SSR request for a single journey Ssr.\n " additionalProperties: false required: - ssrCode - journeyKey properties: ssrCode: type: string description: "The Ssr code.\n " minLength: 1 count: type: integer description: "The number of items to include. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true note: type: string description: "Notes associated with this Ssr.\n " nullable: true journeyKey: type: string description: "The journey key.\n " minLength: 1 TripLoyaltyFilter: type: integer description: "Trip loyalty filter enumeration for selling journeys on a booking.\n\ \ \n\n0 = MonetaryOnly\n1 = PointsOnly\n2 = PointsAndMonetary" x-enumNames: - MonetaryOnly - PointsOnly - PointsAndMonetary enum: - 0 - 1 - 2 ApplyServiceBundle: type: integer description: "The apply service bundle enumeration.\n \n\n0 = Yes\n\ 1 = No\n2 = Copy" x-enumNames: - true - false - Copy enum: - 0 - 1 - 2 IJsonResponseOfIListOfPromotionBase: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PromotionBase' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PromotionBase: type: object description: "Defines a promotion base model.\n " additionalProperties: false properties: code: type: string description: "The promotion code.\n " maxLength: 8 minLength: 0 nullable: true isPassengerPromotion: type: boolean description: "The promotion discount is applied at the passenger level.\n\ \ " isBookingPromotion: type: boolean description: "The promotion discount is applied to the entire booking.\n\ \ " description: type: string description: "The description of the promotion.\n " maxLength: 128 minLength: 0 nullable: true activeDate: type: string description: "The date that the promotion becomes active.\n " format: date-time discontinueDate: type: string description: "The date that the promotion is discontinued.\n " format: date-time nullable: true discontinueFeeCode: type: string description: "The discount fee code representing the calculated discount\n\ for the promotion.\n " maxLength: 6 minLength: 0 nullable: true fareTypes: type: array description: "The list of fare types associated with the promotion.\n \ \ " nullable: true items: type: string passengerDiscountCode: type: string description: "The passenger discount code.\n " maxLength: 4 minLength: 0 nullable: true passengerDiscountLimit: type: integer description: "The passenger discount limit.\n " passengerDiscountSet: type: integer description: "The passenger discount set.\n " inventoryControl: description: "The promotion inventory control.\n " $ref: '#/components/schemas/PromotionInventoryControl' totalUnitCount: type: integer description: "The total unit count.\n " unitsSold: type: integer description: "The total number of units sold.\n " PromotionInventoryControl: type: integer description: "Enumeration representing promotion inventory control.\n \ \ \n\n0 = Open\n1 = IfAvailable\n2 = Closed" x-enumNames: - Open - IfAvailable - Closed enum: - 0 - 1 - 2 MatchCriteria: type: integer description: "Defines the matching criteria for strings.\n \n\n0\ \ = StartsWith\n1 = EndsWith\n2 = Contains\n3 = ExactMatch" x-enumNames: - StartsWith - EndsWith - Contains - ExactMatch enum: - 0 - 1 - 2 - 3 IJsonResponseOfPromotion: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Promotion' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Promotion: type: object description: "Defines a promotion model.\n " additionalProperties: false properties: code: type: string description: "The promotion code.\n " maxLength: 8 minLength: 0 nullable: true isPassengerPromotion: type: boolean description: "The promotion discount is applied at the passenger level.\n\ \ " isBookingPromotion: type: boolean description: "The promotion discount is applied to the entire booking.\n\ \ " description: type: string description: "The description of the promotion.\n " maxLength: 128 minLength: 0 nullable: true activeDate: type: string description: "The date that the promotion becomes active.\n " format: date-time discontinueDate: type: string description: "The date that the promotion is discontinued.\n " format: date-time nullable: true discontinueFeeCode: type: string description: "The discount fee code representing the calculated discount\n\ for the promotion.\n " maxLength: 6 minLength: 0 nullable: true fareTypes: type: array description: "The list of fare types associated with the promotion.\n \ \ " nullable: true items: type: string passengerDiscountCode: type: string description: "The passenger discount code.\n " maxLength: 4 minLength: 0 nullable: true passengerDiscountLimit: type: integer description: "The passenger discount limit.\n " passengerDiscountSet: type: integer description: "The passenger discount set.\n " inventoryControl: description: "The promotion inventory control.\n " $ref: '#/components/schemas/PromotionInventoryControl' totalUnitCount: type: integer description: "The total unit count.\n " unitsSold: type: integer description: "The total number of units sold.\n " allowedOrganizations: type: array description: "The list of organizations that have access to the promotion.\n\ \ " nullable: true items: type: string settings: type: array description: "The list of applicable promotion settings.\n " nullable: true items: $ref: '#/components/schemas/PromotionSetting' PromotionSetting: type: object description: "Defines a promotion setting model.\n " additionalProperties: false required: - promotionSettingTypeCode properties: promotionSettingTypeCode: type: string description: "The promotion setting type code.\n " minLength: 1 name: type: string description: "The setting type name.\n " nullable: true inActive: type: boolean description: "In active\n " schema: type: string description: "The data schema.\n " maxLength: 2147483647 minLength: 0 nullable: true dataVersion: type: integer description: "The promotion setting data version.\n " data: type: string description: "The promotion setting data.\n " nullable: true BlacklistPaymentEntry: type: object description: "Defines the request for a card used in an external payment to\ \ be blacklisted.\n " additionalProperties: false required: - paymentKey properties: reason: description: "The reason why the card is being blacklisted.\nDefaults to\ \ None of no value is specified.\n " nullable: true $ref: '#/components/schemas/BlacklistReasonCode' notes: type: string description: "Additional description of the reason for blacklisting the\ \ card.\n " nullable: true startDate: type: string description: "The start date for the card to be blacklisted.\nDefaults to\ \ the current UTC-based date if not specified.\n " format: date-time nullable: true endDate: type: string description: "The date when the card will be removed from the blacklist.\n\ If not specified or set to null, the payment is blacklisted without expiration.\n\ \ " format: date-time nullable: true paymentKey: type: string description: "The unique identifier of the external payment with the card\ \ number to be blacklist.\n " minLength: 1 BlacklistReasonCode: type: integer description: "Defines the reason for blacklisting a card used in an external\ \ payment.\nDefaults to `None` if no value is specified.\n \n\n\ 0 = None\n1 = ChargedBack\n2 = Lost\n3 = Other\n4 = ProvidedByBank\n5 = Stolen" x-enumNames: - None - ChargedBack - Lost - Other - ProvidedByBank - Stolen enum: - 0 - 1 - 2 - 3 - 4 - 5 DeltaMapperOfBlacklistPaymentEntryEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: reason: description: "The reason why the card is being blacklisted.\nDefaults to\ \ None of no value is specified.\n " nullable: true $ref: '#/components/schemas/BlacklistReasonCode' notes: type: string description: "Additional description of the reason for blacklisting the\ \ card.\n " nullable: true startDate: type: string description: "The start date for the card to be blacklisted.\nDefaults to\ \ the current UTC-based date if not specified.\n " format: date-time nullable: true endDate: type: string description: "The date when the card will be removed from the blacklist.\n\ If not specified or set to null, the payment is blacklisted without expiration.\n\ \ " format: date-time nullable: true BlacklistPaymentEntryEditRequest: type: object description: "Defines the request for editing a blacklisted payment.\n \ \ " additionalProperties: false properties: reason: description: "The reason why the card is being blacklisted.\nDefaults to\ \ None of no value is specified.\n " nullable: true $ref: '#/components/schemas/BlacklistReasonCode' notes: type: string description: "Additional description of the reason for blacklisting the\ \ card.\n " nullable: true startDate: type: string description: "The start date for the card to be blacklisted.\nDefaults to\ \ the current UTC-based date if not specified.\n " format: date-time nullable: true endDate: type: string description: "The date when the card will be removed from the blacklist.\n\ If not specified or set to null, the payment is blacklisted without expiration.\n\ \ " format: date-time nullable: true IJsonResponseOfBlacklistPaymentEntry: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BlacklistPaymentEntry' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfDirectCurrencyConversionAvailability: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/DirectCurrencyConversionAvailability' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' DirectCurrencyConversionAvailability: type: object description: "Defines a direct currency conversion availability model.\n \ \ " additionalProperties: false properties: dccKey: type: string description: "The direct currency conversion key.\n " nullable: true currencyCode: type: string description: "The currency code converting available to convert to.\n \ \ " maxLength: 3 minLength: 0 nullable: true rate: type: number description: "The conversion rate value.\n " format: decimal amount: type: number description: "The conversion rate amount.\n " format: decimal DccAvailabilityBaseRequest: type: object description: "Direct currency conversion request.\n " additionalProperties: false required: - amount - accountNumber - quotedCurrencyCode properties: amount: type: number description: "The amount being applied as a payment.\n " format: decimal accountNumber: type: string description: "The account number.\n " maxLength: 34 minLength: 0 quotedCurrencyCode: type: string description: "The quoted currency code to convert to.\n " minLength: 1 waiveFees: type: boolean description: "Indicates if any payment fee incurred will be waived. Defaults\ \ to false if not set.\nThis flag is for agents only.\n " nullable: true IJsonResponseOfPaymentFeeResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PaymentFeeResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PaymentFeeResponse: type: object description: "Defines information for the payment fee response.\n \ \ " additionalProperties: false required: - feeAmount properties: feeAmount: type: number description: "The amount being payed.\n " format: decimal isFixedAmount: type: boolean description: "Is a fixed amount.\n " passengerFees: type: array description: "Passenger fee details.\n " nullable: true items: $ref: '#/components/schemas/PassengerFee' ManualPaymentFeeRequest: type: object description: "Defines information to be converted to the payment request v2\ \ for a payment fee price request\n " additionalProperties: false required: - amount properties: amount: type: number description: "The amount being payed.\n " format: decimal currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true collectedCurrencyCode: type: string description: "The optional collected currency code. This will be needed\ \ for MCC requests.\n " maxLength: 3 minLength: 0 nullable: true accountNumber: type: string description: "The account number that is used for the PaymentFeePriceRequest\n\ \ " maxLength: 34 minLength: 0 nullable: true paymentMethodCode: type: string description: "The payment method code that is used for the PaymentFeePriceRequest\n\ \ " maxLength: 2 minLength: 0 nullable: true PaymentMethodRequest: type: object description: "Defines a request to apply payment to the booking in state.\n\ \ " additionalProperties: false required: - amount - paymentMethodCode properties: amount: type: number description: "The amount to apply.\n " format: decimal maximum: 2147483647.0 minimum: 0.0 paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true installments: type: integer description: "The requested number of installments. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true paymentMethodCode: type: string description: "Payment method code.\n " maxLength: 2 minLength: 1 deposit: type: boolean description: "Whether to add the payment as a deposit.\n " nullable: true waiveFees: type: boolean description: "Determines if the system calculated payment fee should be\ \ waived when adding this payment. This flag is for agents\nonly.\n \ \ " nullable: true IJsonResponseOfThreeDSecureNativeInitializationResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ThreeDSecureNativeInitializationResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ThreeDSecureNativeInitializationResponse: type: object description: "Defines information for a three d secure Native initialization\ \ response.\n " additionalProperties: false properties: deviceDataCollectionUrl: type: string description: "The device data collection url. Only returned if 3DS is needed.\n\ \ " nullable: true deviceDataCollectionObject: type: string description: "The device data collection base64 object or a jwt to start\ \ device data collection.\nWill be needed to be posted to the device data\ \ collection url.\n " nullable: true bin: type: string description: "The bin of the account number. Typically a card number or\ \ a token to be sent in the request for the payment.\nWill need to be\ \ posted to the device data collection url.\n " nullable: true customFields: type: object description: "For additional custom fields to account for different implementations\ \ of 3DSecure Native.\n " nullable: true additionalProperties: type: string ThreeDSecureNativeInitializationPaymentRequest: type: object description: "Defines information needed for a native three d secure payment\ \ initialization request.\n " additionalProperties: false required: - amount - paymentMethodCode - accountNumber properties: amount: type: number description: "The NewSkies amount.\n " format: decimal maximum: 2147483647.0 minimum: 0.0 currencyCode: type: string description: "The NewSkies currency code. Will default to the booking's\ \ currency code.\n " maxLength: 3 minLength: 0 nullable: true customFields: type: object description: "For custom fields to account for different implementations\ \ of 3DSecure Native.\n " nullable: true additionalProperties: type: string accountAddress: type: string description: "The account address.\n " nullable: true emailAddress: type: string description: "The email address.\n " nullable: true paymentMethodCode: type: string description: "Payment method code.\n " maxLength: 2 minLength: 1 accountNumber: type: string description: "The account number.\n " minLength: 1 expiration: type: string description: "The expiration date of the account.\n " format: date-time accountName: type: string description: "The account name.\n " nullable: true ThreeDSecureNativeInitializationStoredPaymentRequest: type: object description: "Defines information needed for three d secure native stored payment\ \ initialization request.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The NewSkies amount.\n " format: decimal maximum: 2147483647.0 minimum: 0.0 currencyCode: type: string description: "The NewSkies currency code. Will default to the booking's\ \ currency code.\n " maxLength: 3 minLength: 0 nullable: true customFields: type: object description: "For custom fields to account for different implementations\ \ of 3DSecure Native.\n " nullable: true additionalProperties: type: string accountAddress: type: string description: "The account address.\n " nullable: true emailAddress: type: string description: "The email address.\n " nullable: true ThreeDSecureNativePaymentMethodRequest: type: object description: "Defines information needed for a generic payment requested with\ \ ThreeDSecureNative validation. To be used after a\nredirect/challenge for\ \ ThreeDSecureNative.\n " additionalProperties: false required: - transactionIdThreeDSecure - paymentTransactionKey properties: transactionIdThreeDSecure: type: string description: "The transaction id, three d secure. Retrieved from the challenge/redirect.\n\ \ " minLength: 1 paymentTransactionKey: type: string description: "The payment transaction key.\n " minLength: 1 termUrl: type: string description: "The term url.\nDefaults to the HTTP Request location if not\ \ set.\n " nullable: true ThreeDSecurePaymentMethodRequestv3: type: object description: "Defines information needed for a generic payment requested with\ \ ThreeDSecure validation.\n " additionalProperties: false required: - paRes - paymentTransactionKey properties: paRes: type: string description: "The response that comes back from the bank to verify ThreeDSecure\ \ validation.\n " minLength: 1 paReq: type: string description: "The original payment authorization request.\n " nullable: true paymentTransactionKey: type: string description: "The payment transaction key.\n " minLength: 1 IJsonResponseOfPaymentInformationv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PaymentInformationv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PaymentInformationv2: type: object description: "Defines the extra payment information v2.\n " additionalProperties: false properties: threeDSecureResponse: description: "The three d secure response after making an initial payment.\n\ \ " nullable: true $ref: '#/components/schemas/ThreeDSecureResponsev2' directCurrencyConversionOffer: description: "The direct currency conversion offer after making an initial\ \ payment.\n " nullable: true $ref: '#/components/schemas/DirectCurrencyConversionOffer' ThreeDSecureResponsev2: type: object description: "Defines three D secure response, v2.\n " additionalProperties: false properties: redirectUrl: type: string description: "The url to visit for 3DS verification.\n " nullable: true paReq: type: string description: "The 3DS standard PaReq verification token.\n " nullable: true responseUrl: type: string description: "The response url for the bank to use after verification.\n\ \ " nullable: true md: type: string description: "The 3DS standard MD field used for the merchant session tracker.\n\ \ " nullable: true raw: type: string description: "The raw html used for a form post as sent by sky pay.\n \ \ " nullable: true paymentTransactionKey: type: string description: "The payment transaction key.\n " nullable: true threeDSecureVersion: type: string description: "The three d secure version. Indicates the version of 3DS that\ \ was applied during the authentication.\n " nullable: true redirectJwt: type: string description: "The Jwt object created by SkyPay to use when redirecting a\ \ customer.\n " nullable: true redirectJwtUrl: type: string description: "Secondary url that may be included in lieu or in addition\ \ to the Redirect Url.\n " nullable: true StoredPaymentRequestv2: type: object description: "Defines a request to apply person stored payment to the booking\ \ in state, v2.\n " additionalProperties: false required: - amount properties: waiveFees: type: boolean description: "Determines if the system calculated payment fee should be\ \ waived when adding this payment. This flag is for agents\nonly.\n \ \ " nullable: true amount: type: number description: "The amount to apply.\n " format: decimal maximum: 2147483647.0 minimum: 0.0 paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true installments: type: integer description: "The requested number of installments. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true nativeThreeDSecureRequest: description: "The three d secure Native request properties.\n \ \ " nullable: true $ref: '#/components/schemas/NativeThreeDSecure' termUrl: type: string description: "The term url.\nThis could be used for Three D Secure Redirect\ \ or Native.\nDefaults to the HTTP Request location if not set.\n \ \ " nullable: true NativeThreeDSecure: type: object description: "Defines native three d secure request information. This is information\ \ to be sent on a payment\nafter initialization.\n " additionalProperties: false properties: threeDSecureSessionId: type: string description: "The three d secure session id. This is returned by device\ \ data collection.\nThis ties the device data collection to the 3DSecure\ \ Lookup.\n " nullable: true challengePreference: description: "The requested challenge preference.\nIndicates whether the\ \ merchant would like to force the issuer to present a 3DSecure challenge.\n\ Defaults to No Preference.\n " nullable: true $ref: '#/components/schemas/ChallengePreference' challengeWindowSize: description: "The requested challenge window size.\nIndicates the preferred\ \ size of the 3DSecure challenge window.\nDefaults to Full Page.\n \ \ " nullable: true $ref: '#/components/schemas/ChallengePreferenceWindowSize' StoredPaymentRequest: type: object description: "Defines a request to apply person stored payment to the booking\ \ in state.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The amount to apply.\n " format: decimal maximum: 2147483647.0 minimum: 0.0 paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true installments: type: integer description: "The requested number of installments. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true waiveFees: type: boolean description: "Determines if the system calculated payment fee should be\ \ waived when adding this payment. This flag is for agents\nonly.\n \ \ " nullable: true DccRequestBasev2: type: object description: "Model representing the DCC request without a unique key.\n \ \ " additionalProperties: false properties: paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string offerAccepted: type: boolean description: "Indication of whether the DCC offer was accepted or not. This\ \ will default to true if not set.\n " nullable: true deposit: type: boolean description: "Indicates if the payment will be added as deposit.\nDefaults\ \ to false if not set.\n " nullable: true installments: type: integer description: "The requested number of installments.\n " nullable: true MccPaymentMethodRequest: type: object description: "Defines information needed for a mcc payment requested to be added\ \ to the booking in state.\n " additionalProperties: false required: - paymentMethodCode - amount properties: paymentMethodCode: type: string description: "Payment method code.\n " maxLength: 2 minLength: 1 deposit: type: boolean description: "Whether to add the payment as a deposit.\n " nullable: true waiveFees: type: boolean description: "Determines if the system calculated payment fee should be\ \ waived when adding this payment. This flag is for agents\nonly.\n \ \ " nullable: true amount: type: number description: "The amount to apply.\n " format: decimal maximum: 2147483647.0 minimum: 0.0 paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true installments: type: integer description: "The requested number of installments. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true thirdPartyExternalRate: description: "The third party external rate.\n " nullable: true $ref: '#/components/schemas/ExternalRate' ExternalRate: type: object description: "External rate model.\n " additionalProperties: false properties: rateId: type: string description: "The id for this external rate.\n " nullable: true quotedCurrency: type: string description: "The quoted currency for this external rate.\n " maxLength: 3 minLength: 0 nullable: true collectedCurrency: type: string description: "The collected currency for this external rate.\n \ \ " maxLength: 3 minLength: 0 nullable: true exchangeRate: type: number description: "The exchange rate for this external rate.\n " format: decimal MccPaymentRequest: type: object description: "Defines information needed for a mcc stored payment requested\ \ to be added to the booking in state.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The amount to apply.\n " format: decimal maximum: 2147483647.0 minimum: 0.0 paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true installments: type: integer description: "The requested number of installments. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true thirdPartyExternalRate: description: "The third party external rate.\n " nullable: true $ref: '#/components/schemas/ExternalRate' PaymentMethodRequestv2: type: object description: "Defines a payment method request v2.\n " additionalProperties: false required: - paymentMethodCode - amount properties: paymentMethodCode: type: string description: "Payment method code.\n " maxLength: 2 minLength: 1 deposit: type: boolean description: "Whether to add the payment as a deposit.\n " nullable: true waiveFees: type: boolean description: "Determines if the system calculated payment fee should be\ \ waived when adding this payment. This flag is for agents\nonly.\n \ \ " nullable: true amount: type: number description: "The amount to apply.\n " format: decimal maximum: 2147483647.0 minimum: 0.0 paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true installments: type: integer description: "The requested number of installments. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true nativeThreeDSecureRequest: description: "The three d secure native request properties.\n \ \ " nullable: true $ref: '#/components/schemas/NativeThreeDSecure' termUrl: type: string description: "The term url.\nThis could be used for Native or Redirect Three\ \ D Secure.\nDefaults to the HTTP Request location if not set.\n \ \ " nullable: true PaymentRefundRequestv2: type: object description: "The payment refund request, v2.\n " additionalProperties: false required: - amount - paymentMethodCode properties: parentPaymentKey: type: string description: "The payment identifier used if this refund is being reversed\ \ from an existing payment, which in turn, creates a\nline item refund.\n\ When set to null, a booking level refund is made instead.\n \ \ " nullable: true amount: type: number description: "The amount to apply.\n " format: decimal paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true paymentMethodCode: type: string description: "Payment method code.\n " maxLength: 2 minLength: 1 comment: type: string description: "The payment refund comment.\n " nullable: true PaymentRefundRequest: type: object description: "Defines information needed for a generic voucher payment requested\ \ to be added to the booking in state.\n " additionalProperties: false required: - amount - paymentMethodCode properties: parentPaymentKey: type: string description: "The payment identifier used if this refund is being reversed\ \ from an existing payment, which in turn, creates a\nline item refund.\n\ When set to null, a booking level refund is made instead.\n \ \ " nullable: true amount: type: number description: "The amount to apply.\n " format: decimal paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true paymentMethodCode: type: string description: "Payment method code.\n " maxLength: 2 minLength: 1 accountTransactionCode: type: string description: "The account transaction code associated with the account.\n\ \ " nullable: true comment: type: string description: "The payment refund comment.\n " nullable: true ApplyCreditRequest: type: object description: "Defines a request to apply credit from state.\n " additionalProperties: false required: - amount properties: currencyCode: type: string description: "The currency code of the account.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of credit.\n " format: decimal comment: type: string description: "The payment comment, also known as the text details.\n \ \ " nullable: true IJsonResponseOfIDictionaryOfStringAndMccCurrencyInformationv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: $ref: '#/components/schemas/MccCurrencyInformationv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' MccCurrencyInformationv2: type: object description: "Model with the Mcc curency and rate information.\n " additionalProperties: false properties: rate: description: "The external rate.\n " nullable: true $ref: '#/components/schemas/ExternalRate' currency: description: "The currency.\n " nullable: true $ref: '#/components/schemas/Currencyv2' balanceDue: type: number description: "The total balance due using this currency code.\n \ \ " format: decimal Currencyv2: type: object description: "The currency model.\n " additionalProperties: false required: - currencyCode properties: currencyCode: type: string description: "The unique currency code of currency.\n " maxLength: 3 minLength: 1 description: type: string description: "The description of currency.\n " maxLength: 128 minLength: 0 nullable: true roundFactor: type: number description: "The round factor of currency.\n " format: decimal displayDigits: type: integer description: "The display digits of currency.\n " format: int32 displayPrefix: type: string description: "The digit prefix of currency.\n " maxLength: 3 minLength: 0 nullable: true displaySuffix: type: string description: "The digit suffix of currency.\n " maxLength: 3 minLength: 0 nullable: true inActive: type: boolean description: "The flag indicating if the currency is inactive.\n \ \ " ApplyOrganizationCreditRequest: type: object description: "Defines a request to apply organization credit to the booking\ \ in state.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The amount of credit.\n " format: decimal comment: type: string description: "The payment comment, also known as the text details.\n \ \ " nullable: true currencyCode: type: string description: "The currency code of the account.\n " maxLength: 3 minLength: 0 nullable: true waiveFees: type: boolean description: "Determines if the system calculated payment fee should be\ \ waived when adding this payment. This flag is for agents\nonly.\n \ \ " nullable: true organizationCreditCode: type: string description: "The payment method credit code of the agent credit line. If\ \ not set, will default to the default organization\ncredit code.\nNOTE:\ \ It is not recommended to use a custom agency credit payment as it will\ \ not have the same\nbehavior nor be validated like the pre-configured\ \ `AG` credit payment.\n " nullable: true accountReference: type: string description: "The organization account reference. If not set, defaults to\ \ the organization code of the logged-in user.\n " maxLength: 10 minLength: 0 nullable: true ApplyCreditAccountRequestv2: type: object description: "Defines a request to apply credit for an account.\n \ \ " additionalProperties: false required: - referenceNumber - amount properties: referenceNumber: type: string description: "The account reference. This will be the record locator, customer\ \ account number, or organization code depending on\nthe type.\n \ \ " maxLength: 20 minLength: 1 currencyCode: type: string description: "The currency code of the account.\n " maxLength: 3 minLength: 0 nullable: true type: description: "Defines the type of credit being applied.\n " $ref: '#/components/schemas/CreditType' amount: type: number description: "The amount of credit.\n " format: decimal addAsDeposit: type: boolean description: "The flag indicating whether to add credit as a deposit.\n\ \ " nullable: true waiveFees: type: boolean description: "Determines if the system calculated payment fee should be\ \ waived when adding this payment. This flag is for agents\nonly.\n \ \ " nullable: true comment: type: string description: "The payment comment, also known as the text details.\n \ \ " nullable: true CreditType: type: integer description: "Defines the different possible credit types.\n \n\n\ 0 = Customer\n1 = Booking\n2 = Organization" x-enumNames: - Customer - Booking - Organization enum: - 0 - 1 - 2 IJsonResponseOfGetBlacklistPaymentEntryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/GetBlacklistPaymentEntryResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' GetBlacklistPaymentEntryResponse: type: object description: "Defines the response for getting a blacklisted payment.\n \ \ " additionalProperties: false required: - paymentKey properties: reason: description: "The reason why the card is being blacklisted.\nDefaults to\ \ None of no value is specified.\n " nullable: true $ref: '#/components/schemas/BlacklistReasonCode' notes: type: string description: "Additional description of the reason for blacklisting the\ \ card.\n " nullable: true startDate: type: string description: "The start date for the card to be blacklisted.\nDefaults to\ \ the current UTC-based date if not specified.\n " format: date-time nullable: true endDate: type: string description: "The date when the card will be removed from the blacklist.\n\ If not specified or set to null, the payment is blacklisted without expiration.\n\ \ " format: date-time nullable: true paymentKey: type: string description: "The unique identifier of the external payment with the card\ \ number to be blacklist.\n " minLength: 1 createdDate: type: string description: "The date when the blacklist payment was created.\n \ \ " format: date-time nullable: true modifiedDate: type: string description: "The date when the blacklist payment was modified.\n \ \ " format: date-time nullable: true IJsonResponseOfCreditAccount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CreditAccount' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CreditAccount: type: object description: "Defines a credit account information.\n " additionalProperties: false properties: accountReference: type: string description: "The account reference.\n " nullable: true currencyCode: type: string description: "The currency code of the account.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of credit.\n " format: decimal foreignAmount: type: number description: "The foreign amount of credit.\n " format: decimal nullable: true foreignCurrencyCode: type: string description: "The foreign currency code of the account.\n " maxLength: 3 minLength: 0 nullable: true PaymentReversalRequestv2: type: object description: "Defines information needed for reversing a payment in the state\ \ booking, v2.\n " additionalProperties: false required: - amount - paymentMethodCode properties: parentPaymentKey: type: string description: "The payment identifier used if this refund is being reversed\ \ from an existing payment, which in turn, creates a\nline item refund.\n\ When set to null, a booking level refund is made instead.\n \ \ " nullable: true amount: type: number description: "The amount to apply.\n " format: decimal paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true paymentMethodCode: type: string description: "Payment method code.\n " maxLength: 2 minLength: 1 comment: type: string description: "The payment refund comment.\n " nullable: true ApplyBookingCreditRequestv2: type: object description: "Defines a request to apply credit from state.\n " additionalProperties: false required: - request - validation properties: request: description: "The credit details requested.\n " $ref: '#/components/schemas/ApplyCreditRequest' validation: description: "The query to retrieve the booking.\n " $ref: '#/components/schemas/RetrieveBookingv2' RetrieveBookingv2: type: object description: "Model representing the retrieve booking data.\n " additionalProperties: false required: - recordLocator properties: recordLocator: type: string description: "Record locator being requested.\n " maxLength: 12 minLength: 0 emailAddress: type: string description: "The email address of a contact.\n " maxLength: 266 minLength: 0 nullable: true origin: type: string description: "The origin station code.\n " maxLength: 3 minLength: 3 nullable: true firstName: type: string description: "The first name of a passenger or contact.\n " maxLength: 32 minLength: 0 nullable: true lastName: type: string description: "The last name of a passenger or contact.\n " maxLength: 32 minLength: 0 nullable: true customerNumber: type: string description: "One of the passengers customer numbers applied.\n \ \ " maxLength: 20 minLength: 0 nullable: true departureDate: type: string description: "The first journeys departure date.\n " format: date-time nullable: true IJsonResponseOfIListOfSsrPrice: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/SsrPrice' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SsrPrice: type: object description: "Ssr price model.\n " additionalProperties: false properties: key: type: string description: "This key can be either a journey or segment key depending\ \ on the ssr type.\n " nullable: true passengerFee: description: "The passenger fee.\n " nullable: true $ref: '#/components/schemas/PassengerFee' ssrType: description: "The type of ssr.\n " $ref: '#/components/schemas/TravelComponent' IJsonResponseOfIDictionaryOfStringAndIListOfPassengerSsrPrice: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/PassengerSsrPrice' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerSsrPrice: type: object description: "Passenger ssr price model.\n " additionalProperties: false properties: passengerKey: type: string description: "The passenger key.\n " nullable: true ssrPrices: type: array description: "The list of ssr prices associated with the passenger.\n \ \ " nullable: true items: $ref: '#/components/schemas/SsrPrice' PassengerSsrPriceRequest: type: object description: "The multi-Ssr price request model for a single passenger.\n \ \ " additionalProperties: false required: - ssrCodes properties: ssrCodes: type: array description: "The ssr codes. These can be found under the /resources/ssrs\ \ GET endpoint.\n " maxItems: 20 items: type: string collectedCurrencyCode: type: string description: "The collected currency code. These can be found under the\ \ /resources/currencies GET endpoint.\n " maxLength: 3 minLength: 0 nullable: true ResellSsrRequest: type: object description: "The resell Ssr request.\n " deprecated: true x-deprecatedMessage: 4.6 - ResellSsrRequestv2 instead. additionalProperties: false properties: journeyKey: type: string description: "Journey to resell the previously cancelled SSRs on.\n \ \ " nullable: true resellSsrs: type: boolean description: "Indicates whether to resell \"standard\" (non seat-restricted)\ \ SSRs.\n " resellUnitSsrs: type: boolean description: "Indicates whether to resell the unit SSRs, i.e autoassign\ \ a new Unit that supports\nthe same SSRs.\n " waiveSeatFee: type: boolean description: "Indicates whether to waive a seat fee for the new seat assigned\ \ in order to resell unit SSRs.\n " ResellSsrRequestv2: type: object description: "The Resell SSR request v2.\n " additionalProperties: false required: - journeyKey properties: journeyKey: type: string description: "Journey on which to resell the previously cancelled SSRs\n\ \ " minLength: 1 resellSsrs: type: boolean description: "Indicates whether to resell \"standard\" (non seat-restricted)\ \ SSRs.\n " resellUnitSsrs: description: "Indicates whether to resell the unit SSRs, i.e. auto-assign\ \ a new Unit that supports the same SSRs.\n " $ref: '#/components/schemas/ResellUnitSsrFilter' waiveSeatFee: type: boolean description: "Indicates whether to waive a seat fee for the new seat assigned\ \ in order to resell unit SSRs.\n " ResellUnitSsrFilter: type: integer description: "Enumeration representing the filters when reselling seat-dependent\ \ SSRS.\n \n\n0 = DoNotResell\n1 = ResellAndAutoAssignSeats\n2\ \ = ResellAndDoNotAutoAssignSeats" x-enumNames: - DoNotResell - ResellAndAutoAssignSeats - ResellAndDoNotAutoAssignSeats enum: - 0 - 1 - 2 IJsonResponseOfPassengerKeyResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerKeyResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerKeyResponse: type: object description: "Model representing passenger's old and new key in the event of\ \ a key change.\n " additionalProperties: false properties: oldPassengerKey: type: string description: "The old passenger key.\n " nullable: true newPassengerKey: type: string description: "The new passenger key.\n " nullable: true PassengerTypeCodeEditRequest: type: object description: "A model for a request to update the passenger type code.\n \ \ " additionalProperties: false required: - passengerTypeCode properties: passengerTypeCode: type: string description: "The new passenger type code to update the passenger to.\n\ \ " minLength: 1 dateOfBirth: type: string description: "The date of birth for the passenger.\n " format: date-time nullable: true gender: description: "The new gender of the passenger.\nOnly required if GDPR is\ \ enabled.\n " nullable: true $ref: '#/components/schemas/Gender' PassengerBase: type: object description: "Defines the base passenger details.\n " additionalProperties: false properties: customerNumber: type: string description: "The passenger customer number.\n " maxLength: 20 minLength: 0 nullable: true name: description: "The passenger's name.\n " nullable: true $ref: '#/components/schemas/Name' discountCode: type: string description: "The discount code associated with the passenger type.\n \ \ " maxLength: 8 minLength: 0 nullable: true program: description: "The passenger programs.\n " nullable: true $ref: '#/components/schemas/PassengerProgram' info: description: "Additional passenger information.\n " nullable: true $ref: '#/components/schemas/PassengerInformation' DeltaMapperOfPassengerBase: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: customerNumber: type: string description: "The passenger customer number.\n " maxLength: 20 minLength: 0 nullable: true name: description: "The passenger's name.\n " nullable: true properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true discountCode: type: string description: "The discount code associated with the passenger type.\n \ \ " maxLength: 8 minLength: 0 nullable: true program: description: "The passenger programs.\n " nullable: true properties: code: type: string description: "The program code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ nullable: true levelCode: type: string description: "The program level code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ nullable: true number: type: string description: "The program number.\n " maxLength: 32 minLength: 0 nullable: true info: description: "Additional passenger information.\n " nullable: true properties: nationality: type: string description: "The passenger's nationality.\n " maxLength: 2 minLength: 0 nullable: true residentCountry: type: string description: "The resident country.\n " maxLength: 2 minLength: 2 nullable: true gender: description: "The passenger's binary gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The passenger's date of birth.\n " format: date-time nullable: true familyNumber: type: integer description: "The unique identifier of a family registered in the system.\n\ \ " nullable: true declaredGender: type: string description: "The passenger's declared gender. A value of \"F\" is mapped\ \ to a female binary gender. All other values will be\nmapped to a\ \ male binary gender.\n " maxLength: 2 minLength: 0 nullable: true IJsonResponseOfPassengerTravelDocumentCreatedResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerTravelDocumentCreatedResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerTravelDocumentCreatedResponse: type: object description: "Model representing a passenger travel document.\n " additionalProperties: false properties: passengerTravelDocumentKey: type: string description: "A key that uniquely identifies a travel document in the context\ \ of a specific passenger.\n " nullable: true TravelDocumentEditRequest: type: object description: "Defines the edit travel document request.\n " additionalProperties: false properties: birthCountry: type: string description: "The BirthCountry property.\n " nullable: true name: description: "The Name property.\n " nullable: true $ref: '#/components/schemas/Name' nationality: type: string description: "The Nationality property.\n " maxLength: 2 minLength: 0 nullable: true expirationDate: type: string description: "The date when this travel document expires.\n " format: date-time nullable: true number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 nullable: true issuedDate: type: string description: "The date this travel document was issued.\n " format: date-time nullable: true gender: description: "The travel document holder's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true declaredGender: type: string description: "The travel document holder's declared gender.\nThis will override\ \ the gender field on passenger or person POST, PUT, and PATCH requests.\n\ Note: Any value other than \"F\" will cause gender to be updated to Male\ \ by default to support compatibility with\nother systems.\nAdditionally\ \ you cannot change the declared gender and gender fields at the same\ \ time as declared gender\nwill override any gender field value regardless\ \ of the value passed in.\n " maxLength: 2 minLength: 0 nullable: true placeOfBirth: type: string description: "Represents the place of birth. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, numbers,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true placeOfIssue: type: string description: "Represents the place of issue. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true DeltaMapperOfTravelDocumentEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: birthCountry: type: string description: "The BirthCountry property.\n " nullable: true name: description: "The Name property.\n " nullable: true properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true nationality: type: string description: "The Nationality property.\n " maxLength: 2 minLength: 0 nullable: true expirationDate: type: string description: "The date when this travel document expires.\n " format: date-time nullable: true number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 nullable: true issuedDate: type: string description: "The date this travel document was issued.\n " format: date-time nullable: true gender: description: "The travel document holder's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true declaredGender: type: string description: "The travel document holder's declared gender.\nThis will override\ \ the gender field on passenger or person POST, PUT, and PATCH requests.\n\ Note: Any value other than \"F\" will cause gender to be updated to Male\ \ by default to support compatibility with\nother systems.\nAdditionally\ \ you cannot change the declared gender and gender fields at the same\ \ time as declared gender\nwill override any gender field value regardless\ \ of the value passed in.\n " maxLength: 2 minLength: 0 nullable: true placeOfBirth: type: string description: "Represents the place of birth. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, numbers,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true placeOfIssue: type: string description: "Represents the place of issue. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true IJsonResponseOfAvailabilityv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Availabilityv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Availabilityv2: type: object description: "Availabilityv2 represents the availability response based on the\ \ search criteria.\n " additionalProperties: false properties: results: type: array description: "The collection of trip results based on date and markets.\n\ \ " nullable: true items: $ref: '#/components/schemas/TripResult' faresAvailable: type: object description: "The aggregate collection of fares available for all the provided\ \ journeys.\n " nullable: true additionalProperties: $ref: '#/components/schemas/FareReference' currencyCode: type: string description: "The currency code for all displayed fares.\n " maxLength: 17 minLength: 0 nullable: true includeTaxesAndFees: type: boolean description: "Flag indicating if the trip includes taxes and fees.\n \ \ " bundleOffers: type: object description: "The collection of service bundle offers available for all\ \ the provided journeys, if requested.\n " nullable: true additionalProperties: $ref: '#/components/schemas/BundleOffer' TripResult: type: object description: "The trip results represents a wrapper class for the potential\ \ collection of multiple selected dates (flex days or\nrange) selected on\ \ the availability request.\n " additionalProperties: false properties: trips: type: array description: "The collection of available trip by date that contain a collection\ \ of markets.\n " nullable: true items: $ref: '#/components/schemas/TripDateMarket' TripDateMarket: type: object description: "The trip date market represents a specific dates collection of\ \ markets.\n " additionalProperties: false properties: multipleOriginStations: type: boolean description: "Flag indicating if multiple origin stations exist in the journeys\ \ available by market dictionary.\n " multipleDestinationStations: type: boolean description: "Flag indicating if multiple destination stations exist in\ \ the journeys available by market dictionary.\n " date: type: string description: "The date all the different markets are for.\n " format: date-time journeysAvailableByMarket: type: object description: "The dictionary of available journeys for the date per market.\n\ \ " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/AvailableJourney' AvailableJourney: type: object description: "The available journey represents a specific date, market journey\ \ that can be sold.\n " additionalProperties: false properties: flightType: description: "The flight type of the journey.\n " $ref: '#/components/schemas/FlightType' stops: type: integer description: "The number of stops the journey will make.\n " format: int32 designator: description: "The journeys transportation designator.\n " nullable: true $ref: '#/components/schemas/TransportationDesignator' journeyKey: type: string description: "The unique journey key.\n " nullable: true segments: type: array description: "The collection of segments on the journey.\n " nullable: true items: $ref: '#/components/schemas/AvailableSegment' fares: type: array description: "The collection of available fares to be sold for this journey.\n\ \ " nullable: true items: $ref: '#/components/schemas/AvailableJourneyFare' notForGeneralUser: type: boolean description: "A value indicating whether the journey is for a general user.\n\ \ " AvailableSegment: type: object description: "Available segment represents an available segment on a available\ \ journey.\n " additionalProperties: false properties: isSeatmapViewable: type: boolean description: "Indicates if the seatmaps associated with the segment are\ \ retrievable.\nSets to `false` for passive segments, and `true` for non-passive\ \ segments.\n " identifier: description: "The transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' externalIdentifier: description: "The external transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' segmentType: description: "The type of the segment.\n " $ref: '#/components/schemas/SegmentTypes' isChangeOfGauge: type: boolean description: "Flag indicating if the segment is a change of gauge.\n \ \ " isBlocked: type: boolean description: "Flag indicating if the segment is blocked.\n " isHosted: type: boolean description: "Flag indicating if the segment is hosted.\n " designator: description: "The segments transportation designator.\n " nullable: true $ref: '#/components/schemas/TransportationDesignator' segmentKey: type: string description: "The unique segment key.\n " nullable: true cabinOfService: type: string description: "The segments cabin of service.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 nullable: true international: type: boolean description: "Flag indicating if the segment is international.\n \ \ " legs: type: array description: "The collection of legs on the segment.\n " nullable: true items: $ref: '#/components/schemas/Leg' AvailableJourneyFare: type: object description: "The available journey fare represents a journeys fare offering.\ \ If the journey is multi segment multiple fare\ndetails will be present so\ \ each fare can be shown its unique details.\n " additionalProperties: false properties: fareAvailabilityKey: type: string description: "The unique fare availability key.\n " nullable: true details: type: array description: "The collection of fare details for a specific fare.\n \ \ " nullable: true items: $ref: '#/components/schemas/AvailableJourneyFareDetail' isSumOfSector: type: boolean description: "Flag indicating if the journey fare is sum of sector.\n \ \ " AvailableJourneyFareDetail: type: object description: "The available journey fare details represents a journeys fare\ \ availability.\n " additionalProperties: false properties: availableCount: type: integer description: "The availability left.\n " nullable: true status: description: "The classes status.\n " $ref: '#/components/schemas/ClassStatus' reference: type: string description: "The reference to the fare in the master fare collection.\n\ \ " nullable: true serviceBundleSetCode: type: string description: "Service bundle set code.\n " nullable: true bundleReferences: type: array description: "The references to the service bundle offers in the master\ \ bundle offer collection.\n " nullable: true items: type: string ssrReferences: type: array description: "The SSR references that correspond to the applicable SSR prices\ \ in AvailabilityWithSSRResponse's IncludedSsrs.\n " nullable: true items: type: string FareReference: type: object description: "The fare reference represents a master reference of the full fare\ \ details.\n " additionalProperties: false properties: totals: description: "The summed up totals for the collection of fares.\n \ \ " deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. nullable: true $ref: '#/components/schemas/FareReferenceTotals' isSumOfSector: type: boolean description: "Flag indicating if the fare reference is a sum of sector.\n\ \ " fareAvailabilityKey: type: string description: "The unique fare availability key.\n " nullable: true fares: type: array description: "The collection of fares for this reference.\n " nullable: true items: $ref: '#/components/schemas/FareAvailabilityv2' FareReferenceTotals: type: object description: "The fare reference totals represents the sum of all the fares\ \ for a specific available journey fare. If individual\npassenger fare breakdown\ \ in needed that will need to be calculated using the master fare collection.\n\ \ " deprecated: true x-deprecatedMessage: 4.4.5 - This model has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. additionalProperties: false properties: fareTotal: type: number description: "The fares total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. nullable: true revenueTotal: type: number description: "The fares revenue total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. nullable: true publishedTotal: type: number description: "The fares published total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. nullable: true loyaltyTotal: type: number description: "The fares loyalty total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. nullable: true discountedTotal: type: number description: "The fares discounted total.\n " format: decimal deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the totals could yield inaccurate numbers. Please use actual fare availability data to derive the correct total amounts. nullable: true FareAvailabilityv2: type: object description: "The fare availability represents a master fare reference with\ \ all the fare details.\n " additionalProperties: false properties: isGoverning: type: boolean description: "Flag indicating of the fare is the governing fare.\n \ \ " fareBasisCode: type: string description: "The fare basis code.\n " nullable: true classOfService: type: string description: "The class of service.\n " nullable: true classType: type: string description: "The fare class type.\n " nullable: true fareApplicationType: description: "The fare application type.\n " $ref: '#/components/schemas/FareApplicationType' fareStatus: description: "The fare status.\n " $ref: '#/components/schemas/FareStatus' productClass: type: string description: "The fare product class.\n " nullable: true ruleNumber: type: string description: "The fare rule number.\n " nullable: true ruleTariff: type: string description: "The fare rule tariff.\n " nullable: true passengerFares: type: array description: "The fare collection of passenger price breakdown.\n \ \ " nullable: true items: $ref: '#/components/schemas/PassengerFareAvailability' travelClassCode: type: string description: "The travel class code.\nPlease note that this should be a\ \ char and not a string.\n " maxLength: 1 nullable: true isAllotmentMarketFare: type: boolean description: "Gets or sets a value indicating whether this fare is an allotment\ \ market fare.\n " reference: type: string description: "The reference to the fare from the journey fare available.\n\ \ " nullable: true PassengerFareAvailability: type: object description: "Model describing common fare availability information for an entire\ \ availability request.\n " additionalProperties: false required: - passengerType properties: fareDiscountCode: type: string description: "The fare discount code.\n " maxLength: 8 minLength: 0 nullable: true passengerDiscountCode: type: string description: "The passenger discount code.\n " maxLength: 4 minLength: 0 nullable: true passengerType: type: string description: "The type of the passenger.\n " maxLength: 4 minLength: 0 fareAmount: type: number description: "The passenger fare total fare amount.\n " format: decimal revenueFare: type: number description: "The passenger fare revenue fare amount.\n " format: decimal publishedFare: type: number description: "The passenger fare published fare amount.\n " format: decimal loyaltyPoints: type: number description: "The passenger fare loyalty points.\n " format: decimal discountedFare: type: number description: "The discounted fare amount.\n " format: decimal serviceCharges: type: array description: "The service charges.\n " nullable: true items: $ref: '#/components/schemas/ServiceCharge' multiplier: type: integer description: "The number of passengers with the same fare information represented\ \ by passenger type and discount code pair.\n " maximum: 32767.0 minimum: 1.0 deprecated: true x-deprecatedMessage: 4.4.5 - This property has been obsoleted and will be removed in a future version, as the multiplier could yield inaccurate numbers. Please use actual fare availability data to derive the correct multiplier. ticketFareBasis: type: string description: "A fare basis alias which is a more descriptive and custom\ \ value than the fare basis itself.\nThis value is created in FareManager\ \ Plus based on specific fare rule categories and ATPCO documentation.\n\ \ " nullable: true BundleOffer: type: object description: "The bundle offer model.\n " additionalProperties: false properties: bundleCode: type: string description: "The bundle code.\n " maxLength: 4 minLength: 0 nullable: true serviceBundleType: description: "The type of the bundle\n " $ref: '#/components/schemas/ServiceBundleType' bundlePrices: type: array description: "A list of possible price variants of the service\nbundle and\ \ SSRs per journey in the availability.\n " nullable: true items: $ref: '#/components/schemas/BundlePrice' ServiceBundleType: type: integer description: "Defines the types for bundles.\n \n\n0 = Included\n\ 1 = AddOn" x-enumNames: - Included - AddOn enum: - 0 - 1 BundlePrice: type: object description: "The bundle price model.\n " additionalProperties: false properties: totalPrice: type: number description: "The total price for the service bundle, minus taxes.\nIncludes\ \ any fees associated with the bundle.\n " format: decimal taxTotal: type: number description: "The total sales taxes that are applicable to the\nservice\ \ bundle.\n " format: decimal feePrice: type: number description: "The fee price associated with the bundle if there is any.\n\ \ " format: decimal passengerType: type: string description: "The passenger type that is applicable to the service\nbundle.\n\ \ " maxLength: 4 minLength: 0 nullable: true program: description: "The program details that are applicable to the service\nbundle.\n\ \ " nullable: true $ref: '#/components/schemas/BundleProgramDetails' inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the\ \ service bundle.\n " format: decimal bundleSsrPrices: type: array description: "The list of bundle SSR prices.\n " nullable: true items: $ref: '#/components/schemas/BundleSsrPrice' BundleProgramDetails: type: object description: "Represents the bundle program details model.\n " additionalProperties: false properties: code: type: string description: "The program code.\n " maxLength: 3 minLength: 0 nullable: true level: type: string description: "The program level.\n " maxLength: 3 minLength: 0 nullable: true BundleSsrPrice: type: object description: "The bundle SSR price model.\n " additionalProperties: false properties: bundleSsrPrice: type: number description: "The total price of the applied fee.\n " format: decimal taxTotal: type: number description: "The applied sales tax.\n " format: decimal inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the\ \ service bundle ssr.\n " format: decimal ssrCode: type: string description: "The SSR code.\n " maxLength: 4 minLength: 0 nullable: true AvailabilityRebookRequestv3: type: object description: "Model representing an availability rebook search.\n \ \ " additionalProperties: false required: - criteria properties: criteria: type: array description: "The list of availability search criteria.\n " items: $ref: '#/components/schemas/AvailabilityCriteria' taxesAndFees: description: "The taxes and fees rollup mode which affects the pricing information.\n\ \ " $ref: '#/components/schemas/TaxesAndFeesRollupMode' codes: description: "The different code criteria that can be set that can influence\ \ availability response.\n " nullable: true $ref: '#/components/schemas/AvailabilityCodeCriteriav2' returnEmptyResults: type: boolean description: "Whether to include empty results in the returned object.\n\ \ " nullable: true numberOfFaresPerJourney: type: integer description: "The number of fares desired per journey.\n " format: int32 nullable: true AvailabilityCriteria: type: object description: "Defines a single direction search criteria far an availability\ \ call.\n " additionalProperties: false required: - stations - dates properties: stations: description: "The station criteria.\n " $ref: '#/components/schemas/AvailabilityStationCriteria' dates: description: "The date criteria.\n " $ref: '#/components/schemas/AvailabilityDateCriteria' filters: description: "Filters applied to the response for a single direction.\n\ \ " nullable: true $ref: '#/components/schemas/AvailabilityCriteriaFilter' ssrCollectionsMode: description: "Determines if SSR nest information will be returned on the\ \ legs for each available journey segments.\n " nullable: true $ref: '#/components/schemas/AvailabilitySsrCollectionsMode' AvailabilityStationCriteria: type: object description: "Defines the availability criteria stations.\n " additionalProperties: false required: - destinationStationCodes - originStationCodes properties: destinationStationCodes: type: array description: "The Arrival Station Codes.\n " items: type: string originStationCodes: type: array description: "The Departure Station Codes.\n " items: type: string searchDestinationMacs: type: boolean description: "Flag indicating to search by the corresponding MAC associated\ \ with station codes provided.\n " nullable: true searchOriginMacs: type: boolean description: "Flag indicating to search by the corresponding MAC associated\ \ with station codes provided.\n " nullable: true AvailabilityDateCriteria: type: object description: "Defines the availability criteria dates.\n " additionalProperties: false required: - beginDate properties: beginDate: type: string description: "The beginning date to include flights for.\n " format: date-time minLength: 1 startTimeInterval: type: string description: "The beginning time interval to include flights from regardless\ \ of the days.\n " format: duration nullable: true endDate: type: string description: "The ending date to include flights for.\n " format: date-time nullable: true endTimeInterval: type: string description: "The ending time interval to include flights from regardless\ \ of the days.\n " format: duration nullable: true daysOfWeek: type: array description: "The days of the week to include in the provided date range.\n\ \ " nullable: true items: $ref: '#/components/schemas/DayOfWeek' AvailabilityCriteriaFilter: type: object description: "Defines all the different ways the availability response can be\ \ filtered.\n " additionalProperties: false properties: fareInclusionType: description: "Defines the type of fares to be included in the response.\n\ \ " nullable: true $ref: '#/components/schemas/AvailabilityType' compressionType: description: "The class compression type.\n " nullable: true $ref: '#/components/schemas/FareClassControl' maxPrice: type: number description: "The max fare price.\n " format: decimal nullable: true minPrice: type: number description: "The min fare price.\n " format: decimal nullable: true loyalty: description: "Filters fares based on loyalty.\n " nullable: true $ref: '#/components/schemas/LoyaltyFilter' includeAllotments: type: boolean description: "Flag indicating to include allotted fare classes of service.\n\ \ " nullable: true exclusionType: description: "Filters the type of journeys to return.\n " nullable: true $ref: '#/components/schemas/AvailabilityFilter' sortOptions: type: array description: "The list of inventory journey sort options, used for filtering\ \ journeys on the response.\n " nullable: true items: $ref: '#/components/schemas/JourneySortKey' productClasses: type: array description: "The list of product class codes to filter with.\n \ \ " nullable: true items: type: string travelClasses: type: array description: "The list of travel class codes to filter with.\nPlease note\ \ that this should be an array of chars and not an array of string.\n\ \ " nullable: true items: type: string maxLength: 1 fareTypes: type: array description: "The list of fare types.\n " nullable: true items: type: string classesOfService: type: array description: "The list of classes of service.\n " nullable: true items: type: string carrierCode: type: string description: "The desired carrier code.\n " maxLength: 3 minLength: 2 nullable: true identifier: type: string description: "The desired identifier number.\n " maxLength: 4 minLength: 0 nullable: true type: description: "The type filtering based on connections.\n " nullable: true $ref: '#/components/schemas/FlightType' connectionType: description: "Specifies the type of sold as connection when segment connects\ \ with passive segment.\n " nullable: true $ref: '#/components/schemas/SoldAsConnectionType' maxConnections: type: integer description: "The number of max connections.\n " nullable: true bundleControlFilter: description: "Determines what level of service bundle information should\ \ be returned with flight availability.\n " nullable: true $ref: '#/components/schemas/BundleControlFilter' AvailabilityType: type: integer description: "Availability type defines the type of fares to be returned.\n\ \ \n\n0 = Default\n1 = Standby\n2 = Overbook\n3 = NoPricing" x-enumNames: - Default - Standby - Overbook - NoPricing enum: - 0 - 1 - 2 - 3 FareClassControl: type: integer description: "Fare class control enumeration for controlling the number and\ \ type of fares applied to the search response.\n \n\n0 = LowestFareClass\n\ 1 = CompressByProductClass\n2 = Default" x-enumNames: - LowestFareClass - CompressByProductClass - Default enum: - 0 - 1 - 2 LoyaltyFilter: type: integer description: "Availability loyalty filter enumeration for filtering the returning\ \ fares on availability.\n \n\n0 = MonetaryOnly\n1 = PointsOnly\n\ 2 = PointsAndMonetary\n3 = PreserveCurrent" x-enumNames: - MonetaryOnly - PointsOnly - PointsAndMonetary - PreserveCurrent enum: - 0 - 1 - 2 - 3 AvailabilityFilter: type: integer description: "Filter used to filter the types of journeys to return on availability.\n\ \ \n\n0 = Default\n1 = ExcludeDeparted\n2 = ExcludeImminent\n3\ \ = ExcludeUnavailable" x-enumNames: - Default - ExcludeDeparted - ExcludeImminent - ExcludeUnavailable enum: - 0 - 1 - 2 - 3 JourneySortKey: type: integer description: "Defines the sorting keys for the journeys on availability.\n \ \ \n\n0 = ServiceType\n1 = ShortestTravelTime\n2 = LowestFare\n\ 3 = HighestFare\n4 = EarliestDeparture\n5 = LatestDeparture\n6 = EarliestArrival\n\ 7 = LatestArrival\n8 = NoSort\n9 = BiasOnlineCommercialDuplicates\n10 = JourneyNumber" x-enumNames: - ServiceType - ShortestTravelTime - LowestFare - HighestFare - EarliestDeparture - LatestDeparture - EarliestArrival - LatestArrival - NoSort - BiasOnlineCommercialDuplicates - JourneyNumber enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 SoldAsConnectionType: type: integer description: "Enum to define if a connection is sold as domestic or international.\n\ \ \n\n0 = None\n1 = Domestic\n2 = International\n3 = Both" x-enumNames: - None - Domestic - International - Both enum: - 0 - 1 - 2 - 3 BundleControlFilter: type: integer description: "Filter used to segregate the bundle information to return on flight\ \ availability.\n \n\n0 = Disabled\n1 = ReturnBundleSets\n2 = ReturnBundleOffers" x-enumNames: - Disabled - ReturnBundleSets - ReturnBundleOffers enum: - 0 - 1 - 2 AvailabilitySsrCollectionsMode: type: integer description: "SSR collection mode determines whethere SSR availability should\ \ be checked and returned on availability.\n \n\n0 = None\n1 =\ \ Leg" x-enumNames: - None - Leg enum: - 0 - 1 TaxesAndFeesRollupMode: type: integer description: "Indicates how \"all-up\" service charges will be rolled-up in\ \ the availability response.\n \n\n0 = None\n1 = Taxes\n2 = TaxesAndFees" x-enumNames: - None - Taxes - TaxesAndFees enum: - 0 - 1 - 2 AvailabilityCodeCriteriav2: type: object description: "Describes the different code criteria that can be set that can\ \ influence availability response.\n " additionalProperties: false properties: currencyCode: type: string description: "The currency code for fare pricing.\n " maxLength: 3 minLength: 0 nullable: true promotionCode: type: string description: "The promotion code to be applied.\n " maxLength: 8 minLength: 0 nullable: true sourceOrganization: type: string description: "The organization to use when evaluating availability of private\ \ fares. If specified, this organization code will\nalso be used for evaluation\ \ of any organization rules on sales taxes and travel fees (if included\ \ in the response).\nIf blank or not specified, the logged-in user's organization\ \ will be used.\n " maxLength: 10 minLength: 0 nullable: true currentSourceOrganization: type: string description: "The current source point of sale organization on the PNR.\ \ May be blank or unspecified if the source point of sale\norganization\ \ has not yet been set on the PNR. If blank or unspecified, the logged-in\ \ user's organization will be\nused.\n " maxLength: 10 minLength: 0 nullable: true AvailabilityMoveRequest: type: object description: "Defines the availability move request.\n " additionalProperties: false required: - journeyKey - stations - dates properties: filters: description: "The filtering criteria.\n " nullable: true $ref: '#/components/schemas/AvailabilityMoveFilterCriteria' journeyKey: type: string description: "The journey sell key to move.\n " minLength: 1 stations: description: "The station criteria.\n " $ref: '#/components/schemas/AvailabilityStationCriteria' dates: description: "The date criteria.\n " $ref: '#/components/schemas/AvailabilityDateCriteria' flightFilters: description: "The flight search criteria.\n " nullable: true $ref: '#/components/schemas/AvailabilityFlightCriteria' type: description: "Defines the type of fares to be returned.\n " nullable: true $ref: '#/components/schemas/AvailabilityType' passengerMoveType: description: "The passenger move type.\n " $ref: '#/components/schemas/MovePassengerJourneyType' AvailabilityMoveFilterCriteria: type: object description: "Filter criteria filters the move availability responses results.\n\ \ " additionalProperties: false properties: filter: description: "Filters the type of journeys to return.\n " nullable: true $ref: '#/components/schemas/AvailabilityFilter' sortKeys: type: array description: "The list of inventory journey sort keys. Used for filtering\ \ journeys on the response.\n " nullable: true items: $ref: '#/components/schemas/JourneySortKey' AvailabilityFlightCriteria: type: object description: "The specific flight criteria for the availability criteria.\n\ \ " additionalProperties: false properties: carrierCode: type: string description: "The desired carrier code.\n " maxLength: 3 minLength: 2 nullable: true flightNumber: type: string description: "The desired flight number.\n " maxLength: 4 minLength: 0 nullable: true type: description: "The flight type filtering based on connections.\n \ \ " nullable: true $ref: '#/components/schemas/FlightType' maxConnectingFlights: type: integer description: "The number of max connecting flights.\n " nullable: true MovePassengerJourneyType: type: integer description: "The type of move to perform for the passengers on the journey.\n\ \ \n\n0 = None\n1 = Irop\n2 = Diversion\n4 = FlightClose\n5 = FlyAhead\n\ 6 = SplitJourney\n7 = SelfServiceRebooking\n8 = HIDR" x-enumNames: - None - Irop - Diversion - FlightClose - FlyAhead - SplitJourney - SelfServiceRebooking - HIDR enum: - 0 - 1 - 2 - 4 - 5 - 6 - 7 - 8 MoveRequestv2: type: object description: "Defines the move journey request for a booking in state.\n \ \ " additionalProperties: false required: - fromJourneyKey - journeyKey - fareKey properties: fromJourneyKey: type: string description: "The journey key to move from.\n " minLength: 1 journeyKey: type: string description: "The journey key to move to.\n " minLength: 1 fareKey: type: string description: "The fare key to move to.\n " minLength: 1 moveType: description: "The type of move that is requested.\n " $ref: '#/components/schemas/MovePassengerJourneyType' ignoreClosedFlightStatus: type: boolean description: "If true then the move will be allowed even if the legs of\ \ FromJourney have been\nmarked as Closed.\nIf false, the move will be\ \ disallowed if any one of the legs\nof FromJourney has been marked as\ \ Closed.\n " ignoreLiftStatus: description: "Controls whether the Move is allowed to ignore boarded and/or\n\ checked-in statuses.\n " $ref: '#/components/schemas/IgnoreLiftStatus' boardingSequenceOffset: type: integer description: "If set to zero and MovePassengerJourneyType is not Diversion,\ \ the boarding sequence\nof the original segments will be copied to the\ \ new (moved to) segments.\nIf set to a value other than zero and MovePassengerJourneyType\ \ is not Diversion,\nthe boarding sequence of the original segments will\ \ be copied to the new (moved to)\nsegments and then incremented by the\ \ specified BoardingSequenceOffset.\nBoarding sequence is not preserved\ \ for Diversion moves.\n " moveSsrOption: description: "Controls whether to move SSRs from FromJourney to ToJourney.\n\ \ " nullable: true $ref: '#/components/schemas/MoveSsrOption' standbyPriorityCode: type: string description: "Standby priority code.\n " nullable: true inventoryControlType: description: "Inventory control.\n " $ref: '#/components/schemas/InventoryControlType' changeReasonCode: description: "Change reason code.\n " nullable: true $ref: '#/components/schemas/ChangeReasonCodes' IgnoreLiftStatus: type: integer description: "Defines the lift status ignore level for Journey Move/Cancel.\n\ \ \n\n0 = IgnoreNotAllowed\n1 = IgnoreCheckin\n2 = IgnoreBoarded" x-enumNames: - IgnoreNotAllowed - IgnoreCheckin - IgnoreBoarded enum: - 0 - 1 - 2 MoveSsrOption: type: integer description: "How to handle SSRs on move.\n \n\n0 = OverbookSsr\n\ 1 = MoveAvailableSsr\n2 = MoveNone" x-enumNames: - OverbookSsr - MoveAvailableSsr - MoveNone enum: - 0 - 1 - 2 BagTagPrintHistoryRequest: type: object description: "Contains information needed to add bag tag print history for a\ \ specific passenger.\n " additionalProperties: false required: - legKey - bagTagInformation properties: legKey: type: string description: "Leg key where the bag is checked in.\n " minLength: 1 receivedBy: type: string description: "Received by.\n " nullable: true passengerName: description: "The name of the passenger.\n " nullable: true $ref: '#/components/schemas/Name' isBagTagSelfPrinted: type: boolean description: "Whether to make the bag tag status self printed.\n \ \ " nullable: true bagTagInformation: type: array description: "List of bags to add to bag tag print history.\n \ \ " items: $ref: '#/components/schemas/BagTagInformation' BagTagInformation: type: object description: "Defines bag tag information.\n " additionalProperties: false properties: osTag: type: string description: "The os tag.\n " maxLength: 32 minLength: 0 nullable: true taggedToStation: type: string description: "The tagged to station on the baggage object.\n " maxLength: 3 minLength: 3 nullable: true weight: type: integer description: "The weight of the baggage.\n " maximum: 32767.0 minimum: 0.0 weightType: description: "The weight type of the baggage.\n " $ref: '#/components/schemas/WeightType' originStation: type: string description: "The origin station of the baggage.\n " maxLength: 3 minLength: 3 nullable: true IJsonResponseOfIListOfBagTagPrintHistory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BagTagPrintHistory' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BagTagPrintHistory: type: object description: "Defines bag tag print history.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' receivedBy: type: string description: "The received by name.\n " maxLength: 64 minLength: 0 nullable: true createdDate: type: string description: "The created date.\n " format: date-time nullable: true departureDate: type: string description: "The departure date.\n " format: date-time identifier: description: "The unique transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' passengerName: description: "The passenger name.\n " nullable: true $ref: '#/components/schemas/Name' osTag: type: string description: "The os tag.\n " maxLength: 32 minLength: 0 nullable: true taggedToStation: type: string description: "The tagged to station on the baggage object.\n " maxLength: 3 minLength: 3 nullable: true weight: type: integer description: "The baggage weight.\n " maximum: 32767.0 minimum: 0.0 weightType: description: "The baggage weight type.\n " $ref: '#/components/schemas/WeightType' isBagTagSelfPrinted: type: boolean description: "Whether the bag tag is self printed.\n " nullable: true IJsonResponseOfHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/HistoryResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' HistoryResponse: type: object description: "Defines a booking history response.\n " additionalProperties: false properties: pageKey: type: string description: "The key of the last item in the history list.\n \ \ " nullable: true histories: type: array description: "The booking history list.\n " nullable: true items: $ref: '#/components/schemas/BookingHistory' IJsonResponseOfSeatAssignmentHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SeatAssignmentHistoryResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SeatAssignmentHistoryResponse: type: object description: "Defines a seat assignment history response.\n " additionalProperties: false properties: pageKey: type: string description: "The key of the last item in the history list.\n \ \ " nullable: true histories: type: array description: "The seat assignment history list.\n " nullable: true items: $ref: '#/components/schemas/SeatAssignmentHistory' SeatAssignmentHistory: type: object description: "Defines a seat assignment history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' receivedBy: type: string description: "The received by name.\n " maxLength: 64 minLength: 0 nullable: true receivedByReference: type: string description: "The received by reference number.\n " maxLength: 20 minLength: 0 nullable: true createdDate: type: string description: "The the history entry was created.\n " format: date-time nullable: true designator: description: "The market designator.\n " nullable: true $ref: '#/components/schemas/MarketDesignator' identifier: type: string description: "The unique transportation identifier.\n " nullable: true seatAssignment: type: string description: "The seat assignment.\n " nullable: true compartment: type: string description: "The compartment containing the seat.\n " nullable: true name: description: "The passenger name.\n " nullable: true $ref: '#/components/schemas/Name' MarketDesignator: type: object description: "Model information about the date market which identifies a market\ \ and the departure date.\n " additionalProperties: false required: - destination - origin - departureDate properties: destination: type: string description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 origin: type: string description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 departureDate: type: string description: "The departure date.\n " format: date-time minLength: 1 SeatAssignmentEvent: type: integer description: "Represents the different events that trigger an\nentry into the\ \ seat assignment history.\n \n\n4 = AssignedSeat\n5 = RemoveSeat" x-enumNames: - AssignedSeat - RemoveSeat enum: - 4 - 5 IJsonResponseOfSegmentChangeHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SegmentChangeHistoryResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SegmentChangeHistoryResponse: type: object description: "Defines a segment change history response.\n " additionalProperties: false properties: pageKey: type: string description: "The key of the last item in the history list.\n \ \ " nullable: true histories: type: array description: "The segment change history list.\n " nullable: true items: $ref: '#/components/schemas/SegmentChangeHistory' SegmentChangeHistory: type: object description: "Defines a segment change history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' receivedBy: type: string description: "The received by name.\n " maxLength: 64 minLength: 0 nullable: true receivedByReference: type: string description: "The received by reference number.\n " maxLength: 20 minLength: 0 nullable: true createdDate: type: string description: "The the history entry was created.\n " format: date-time nullable: true daysOfWeek: type: array description: "The days of the week of the operation.\n " nullable: true items: $ref: '#/components/schemas/DayOfWeek' segmentNumber: type: integer description: "The segment number.\n " nullable: true classOfService: type: string description: "The class of service.\n " nullable: true market: description: "The market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' stopCount: type: integer description: "The number of stops in the reservation.\n " connectionIndicator: type: string description: "The connection indicator.\nPlease note that this should be\ \ a char and not a string.\n " maxLength: 1 nullable: true passengerCount: type: integer description: "The number of passengers on the booking.\n " scheduledArrivalTime: type: string description: "The scheduled time of arrival local to the arrival station.\n\ \ " format: date-time nullable: true scheduledDepartureTime: type: string description: "The scheduled time of departure local to the arrival station.\n\ \ " format: date-time nullable: true fareBasis: type: string description: "An alphanumeric identifier assigned to a fare.\n \ \ " nullable: true fareAmount: type: number description: "The cash value of the fare.\n " format: decimal nullable: true SegmentChangeEvent: type: integer description: "Represents the different events that trigger an entry into the\ \ segment change history.\n \n\n6 = AddedFlight\n7 = DeletedFlight" x-enumNames: - AddedFlight - DeletedFlight enum: - 6 - 7 IJsonResponseOfFlightMoveHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FlightMoveHistoryResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FlightMoveHistoryResponse: type: object description: "Defines a flight move history response.\n " additionalProperties: false properties: pageKey: type: string description: "The key of the last item in the history list.\n \ \ " nullable: true histories: type: array description: "The flight move history list.\n " nullable: true items: $ref: '#/components/schemas/FlightMoveHistory' FlightMoveHistory: type: object description: "Defines a flight move history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' receivedBy: type: string description: "The received by name.\n " maxLength: 64 minLength: 0 nullable: true receivedByReference: type: string description: "The received by reference number.\n " maxLength: 20 minLength: 0 nullable: true createdDate: type: string description: "The the history entry was created.\n " format: date-time nullable: true previousMarket: description: "The previous market designator for the journey the passenger\n\ was moved from.\n " nullable: true $ref: '#/components/schemas/MarketDesignator' newMarket: description: "The new market designator for the journey the passenger\n\ was moved to.\n " nullable: true $ref: '#/components/schemas/MarketDesignator' previousIdentifier: type: string description: "The previous transportation identifier for the journey the\ \ passenger\nwas moved from.\n " nullable: true newIdentifier: type: string description: "The new transportation identifier for the journey the passenger\n\ was moved to.\n " nullable: true changeReason: description: "The reason for the move operation.\n " $ref: '#/components/schemas/ChangeReasonCodes' IJsonResponseOfItinerarySentHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ItinerarySentHistoryResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ItinerarySentHistoryResponse: type: object description: "Defines an itinerary sent history response.\n " additionalProperties: false properties: pageKey: type: string description: "The key of the last item in the history list.\n \ \ " nullable: true histories: type: array description: "The itinerary sent history list.\n " nullable: true items: $ref: '#/components/schemas/ItinerarySentHistory' ItinerarySentHistory: type: object description: "Defines an itinerary sent history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' receivedBy: type: string description: "The received by name.\n " maxLength: 64 minLength: 0 nullable: true receivedByReference: type: string description: "The received by reference number.\n " maxLength: 20 minLength: 0 nullable: true createdDate: type: string description: "The the history entry was created.\n " format: date-time nullable: true contact: type: string description: "The booking contact triggering the sending of the itinerary.\n\ \ " nullable: true distributionOption: description: "The distribution method in sending the itinerary.\n \ \ " $ref: '#/components/schemas/DistributionOption' sent: type: string description: "The timestamp on when the itinerary was sent.\n \ \ " format: date-time IJsonResponseOfHoldDateChangeHistoryResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/HoldDateChangeHistoryResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' HoldDateChangeHistoryResponse: type: object description: "Defines a hold date change history response.\n " additionalProperties: false properties: pageKey: type: string description: "The key of the last item in the history list.\n \ \ " nullable: true histories: type: array description: "The hold date change history list.\n " nullable: true items: $ref: '#/components/schemas/HoldDateChangeHistory' HoldDateChangeHistory: type: object description: "Defines a hold date change history log entry.\n " additionalProperties: false properties: pointOfSale: description: "The point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' sourcePointOfSale: description: "The source point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' receivedBy: type: string description: "The received by name.\n " maxLength: 64 minLength: 0 nullable: true receivedByReference: type: string description: "The received by reference number.\n " maxLength: 20 minLength: 0 nullable: true createdDate: type: string description: "The the history entry was created.\n " format: date-time nullable: true previousHoldTime: type: string description: "The previous hold time for the booking.\n " format: date-time nullable: true holdTime: type: string description: "The current hold time for the booking.\n " format: date-time nullable: true HoldDateChangeEvent: type: integer description: "Represents the different events that trigger an\nentry into the\ \ hold date change history.\n \n\n66 = Created\n67 = Removed\n\ 68 = Changed" x-enumNames: - Created - Removed - Changed enum: - 66 - 67 - 68 IJsonResponseOfIListOfBookingMessageHistory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BookingMessageHistory' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingMessageHistory: type: object description: "Defines a booking message history log entry.\n " additionalProperties: false properties: type: description: "The message history type.\n " $ref: '#/components/schemas/BookingMessageHistoryType' message: type: string description: "The message.\n " nullable: true createdDate: type: string description: "The created date.\n " format: date-time BookingMessageHistoryType: type: integer description: "Represents the booking message history types.\n \n\n\ 0 = TeletypeMessage\n1 = ETicket\n2 = GovernmentSecurity\n3 = PnrGovernment\n\ 4 = BaggageMessage\n5 = Iatci\n6 = EMD" x-enumNames: - TeletypeMessage - ETicket - GovernmentSecurity - PnrGovernment - BaggageMessage - Iatci - EMD enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 IJsonResponseOfIListOfBookingNotificationHistory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BookingNotificationHistory' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingNotificationHistory: type: object description: "Defines a booking notification history.\n " additionalProperties: false properties: bookingNotificationHistoryKey: type: string description: "The booking notification history key.\n " nullable: true createdDate: type: string description: "Date and time the history was logged.\n " format: date-time eventTypeCode: description: "Event type code of the notification.\n " $ref: '#/components/schemas/SubscriptionEventType' deliveryMethodCode: type: string description: "Delivery method code of the notification.\n " nullable: true destination: type: string description: "Destination address of the notification.\n " nullable: true cultureCode: type: string description: "Culture code of the notification.\n " nullable: true detail: type: string description: "Details of the booking notification history.\n " nullable: true minutesToEvent: type: integer description: "Reminder time for the notification.\n " format: int32 SubscriptionEventType: type: integer description: "Represents the different subscription events.\n \n\n\ 0 = Unknown\n1 = Departure\n2 = DepartureDelay\n3 = Arrival\n4 = ArrivalDelay\n\ 5 = ScheduleChange\n6 = CheckIn\n7 = Gate\n8 = IropMove\n9 = InventoryCancel" x-enumNames: - Unknown - Departure - DepartureDelay - Arrival - ArrivalDelay - ScheduleChange - CheckIn - Gate - IropMove - InventoryCancel enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 IJsonResponseOfIListOfServiceCharge: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ServiceCharge' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CommitPassengerFeeRequest: type: object description: "Defines the request to retrieve a service fee.\n " additionalProperties: false required: - feeCode properties: note: type: string description: "The note.\n " maxLength: 128 minLength: 0 nullable: true origin: type: string description: "The origin station code.\n " maxLength: 3 minLength: 3 nullable: true collectedCurrencyCode: type: string description: "The collected currency code.\n " maxLength: 3 minLength: 1 nullable: true feeCode: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 feePricingMode: description: "Determines if fees are to be paid in points or with currency.\n\ \ " nullable: true $ref: '#/components/schemas/FeePricingMode' passengerKey: type: string description: "The passenger key.\n " nullable: true FeeRequestBase: type: object description: "Defines the request to retrieve a service fee.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The override amount.\n " format: decimal collectedCurrencyCode: type: string description: "The collected currency code.\n " maxLength: 3 minLength: 1 nullable: true MultipleFeeOverrideRequest: type: object description: "Defines the multiple fee override request.\n " additionalProperties: false properties: feeRequests: type: array description: "The list of fee requests.\n " nullable: true items: $ref: '#/components/schemas/FeeRequest' FeeRequest: type: object description: "Defines the request to retrieve a service fee.\n " additionalProperties: false required: - amount - feeKey properties: amount: type: number description: "The override amount.\n " format: decimal collectedCurrencyCode: type: string description: "The collected currency code.\n " maxLength: 3 minLength: 1 nullable: true feeKey: type: string description: "The passenger fee key.\n " minLength: 1 IJsonResponseOfGetOverrideFeeQuoteResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/GetOverrideFeeQuoteResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' GetOverrideFeeQuoteResponse: type: object description: "Defines the get override fee quote response.\n " additionalProperties: false properties: feeOverrideCharges: type: array description: "The list of service charges that contain the fee override\ \ amounts.\n " nullable: true items: $ref: '#/components/schemas/ServiceCharge' IJsonResponseOfPassengerFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerFee' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPassengerFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerFee' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerSeatFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerSeatFee' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerSeatFee: type: object description: "Passenger seat fee model.\n " additionalProperties: false required: - code properties: type: description: "The fee type.\n " $ref: '#/components/schemas/FeeType' ssrCode: type: string description: "The SSR code.\n " nullable: true ssrNumber: type: integer description: "The fee SSR number.\n " paymentNumber: type: integer description: "The fee payment number.\n " isConfirmed: type: boolean description: "A status flag to indicate if the fee has been confirmed or\ \ not.\n " isConfirming: type: boolean description: "A status flag to indicate if the fee is confirming or not.\n\ \ " isConfirmingExternal: type: boolean description: "A status flag to indicate if the fee is confirming external\ \ or not.\n " code: type: string description: "The fee code.\n " maxLength: 6 minLength: 0 detail: type: string description: "The fee detail.\n " maxLength: 32 minLength: 0 nullable: true passengerFeeKey: type: string description: "The passenger fee key.\n " nullable: true override: type: boolean description: "The fee override.\n " flightReference: type: string description: "The flight reference which signifies a link to a segment and\ \ or leg.\n " maxLength: 22 minLength: 0 nullable: true note: type: string description: "The fee notes.\n " maxLength: 128 minLength: 0 nullable: true createdDate: type: string description: "The created date for the fee.\n " format: date-time nullable: true isProtected: type: boolean description: "Indicates if the fee is protected.\n " serviceCharges: type: array description: "The list of service charges for the fee.\n " nullable: true items: $ref: '#/components/schemas/ServiceCharge' passengerKey: type: string description: "The passenger key.\n " nullable: true IJsonResponseOfIDictionaryOfStringAndIListOfPassengerSeatFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/PassengerSeatFee' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AutoAssignSeatFeeQuoteRequest: type: object description: "Represents a seat fee quote request for auto-assigned seats.\n\ \ " additionalProperties: false properties: seatedNearPrimary: type: array description: "The list of passenger keys for seating assignments near the\ \ primary passenger.\nOnly passengers on the list and the primary passenger\ \ will be assigned\nseats. If the list is empty, seats will be assigned\ \ to all passengers.\n " nullable: true items: type: string preferences: description: "The seat preference.\n " nullable: true $ref: '#/components/schemas/SeatPreferences' inventoryControlType: description: "The type of hold placed on seats.\n " nullable: true $ref: '#/components/schemas/UnitInventoryControlType' ignoreSeatSsrs: type: boolean description: "Determines whether or not SSRs associated with the seat will\ \ be ignored when determining\nunit availability.\n " nullable: true seatAssignmentMode: description: "The seat assignment mode can affect available units in seat\ \ maps and whether or not\nseat fees are charged based on channel type,\ \ role settings, customer programs\nand/or class of service.\n \ \ " nullable: true $ref: '#/components/schemas/SeatAssignmentMode' monetaryOnly: type: boolean description: "Indicates whether the fee to be priced is to be priced in\ \ money or points.\n " nullable: true collectedCurrencyCode: type: string description: "Optional collection currency code. If different from the booking\ \ currency, \nfees in the collected currency will be returned if a currency\ \ conversion configuration exists.\n " maxLength: 3 minLength: 0 nullable: true SeatFeeQuoteRequest: type: object description: "Represents a seat fee quote request.\n " additionalProperties: false required: - seatPreference properties: seatPreference: description: "The seat preference.\n " $ref: '#/components/schemas/SeatPreference' inventoryControlType: description: "The type of hold placed on seats.\n " nullable: true $ref: '#/components/schemas/UnitInventoryControlType' ignoreSeatSSRs: type: boolean description: "Determines whether or not SSRs associated with the seat will\ \ be ignored when determining\nunit availability.\n " nullable: true seatAssignmentMode: description: "The seat assignment mode can affect available units in seat\ \ maps and whether or not\nseat fees are charged based on channel type,\ \ role settings, customer programs\nand/or class of service.\n \ \ " nullable: true $ref: '#/components/schemas/SeatAssignmentMode' monetaryOnly: type: boolean description: "Indicates whether the fee to be priced is to be priced in\ \ money or points.\n " nullable: true collectedCurrencyCode: type: string description: "Optional currency code. If different than the booking currency\ \ code,\nfees in that currency will be returned if the conversion exists\ \ in new skies utilities\n " maxLength: 3 minLength: 0 nullable: true IJsonResponseOfIssueETicketResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/IssueETicketResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IssueETicketResponse: type: object description: "The response from issuing an e-ticket.\n " additionalProperties: false properties: ticketNumbers: type: array description: "The collection of issued or re-issued e-tickets.\n \ \ " nullable: true items: type: string IJsonResponseOfETicketBookingValidationResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ETicketBookingValidationResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ETicketBookingValidationResponse: type: object description: "The response for e-ticket booking validation.\n " additionalProperties: false properties: eTicketQueueStatus: description: "The e-ticket queue status.\n " $ref: '#/components/schemas/ETicketQueueStatus' ETicketQueueStatus: type: integer description: "Defines the queueing status of e-tickets in the booking.\n \ \ \n\n0 = None\n1 = NewIssue\n2 = Reissue\n3 = Revalidate" x-enumNames: - None - NewIssue - Reissue - Revalidate enum: - 0 - 1 - 2 - 3 IJsonResponseOfIListOfETicketCoupon: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ETicketCoupon' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ETicketCoupon: type: object description: "The coupon on an e-ticket.\n " additionalProperties: false properties: couponNumber: type: integer description: "The coupon number.\n " maximum: 4.0 minimum: 1.0 nullable: true marketInformation: description: "The market information of the coupon.\n " nullable: true $ref: '#/components/schemas/MarketInformation' classOfService: type: string description: "The class of service or booking class.\n " maxLength: 8 minLength: 0 nullable: true seatingStatusCode: description: "Status of the reservation. This column displays OK for adult\ \ and NS (No Seat) for infant in lap passengers.\n " $ref: '#/components/schemas/SeatingStatusCode' fareBasisCode: type: string description: "Fare basis code and ticket designator.\n " nullable: true couponStatus: description: "The coupon status.\n " $ref: '#/components/schemas/ETicketCouponStatusCode' notValidBefore: type: string description: "The travel validity before date.\n " format: date-time nullable: true notValidAfter: type: string description: "The travel validity after date.\n " format: date-time nullable: true baggageAllowance: description: "Contains the free baggage allowance.\n " nullable: true $ref: '#/components/schemas/BaggageAllowanceInfo' isArrivalUnknown: type: boolean description: "Indicates if the arrival information for the coupon is unknown\ \ (i.e., ARNK).\n " SeatingStatusCode: type: integer description: "Defines the seating status code for an e-ticket.\n \ \ \n\n0 = Unknown\n1 = BookingConfirmed\n2 = NoSeat" x-enumNames: - Unknown - BookingConfirmed - NoSeat enum: - 0 - 1 - 2 ETicketCouponStatusCode: type: integer description: "Defines the e-ticket coupon status code.\n \n\n0 =\ \ Unknown\n1 = OaControl\n2 = Flown\n3 = Boarded\n4 = CheckedIn\n5 = Exchanged\n\ 6 = Open\n7 = NoSeat\n8 = Confirmed\n9 = Printed\n10 = Refunded\n11 = Requested\n\ 12 = Suspended\n13 = SpaceAvailable\n14 = Ticketed\n15 = Voided\n16 = InfoOnly\n\ 17 = IrregularOps\n18 = Unavailable\n19 = PrintExchanged\n20 = Closed\n21\ \ = Override\n22 = ConvertedToFim\n23 = RefundTaxesFeesCharges" x-enumNames: - Unknown - OaControl - Flown - Boarded - CheckedIn - Exchanged - Open - NoSeat - Confirmed - Printed - Refunded - Requested - Suspended - SpaceAvailable - Ticketed - Voided - InfoOnly - IrregularOps - Unavailable - PrintExchanged - Closed - Override - ConvertedToFim - RefundTaxesFeesCharges 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 BaggageAllowanceInfo: type: object description: "Represents baggage allowance information contained in an e-ticket.\n\ \ " additionalProperties: false properties: quantity: type: integer description: "The baggage allowance quantity.\n " format: int32 type: description: "The baggage allowance type.\n " $ref: '#/components/schemas/BaggageAllowanceType' weightType: description: "The baggage allowance unit / weight type.\n " $ref: '#/components/schemas/WeightType' BaggageAllowanceType: type: integer description: "Defines the baggage allowance type in a passenger e-ticket.\n\ \ \n\n0 = Unknown\n1 = Weight\n2 = PerPiece\n3 = None" x-enumNames: - Unknown - Weight - PerPiece - None enum: - 0 - 1 - 2 - 3 IJsonResponseOfETicketCoupon: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ETicketCoupon' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIDictionaryOfCharAndContact: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: $ref: '#/components/schemas/Contact' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfBundleApplicationDetails: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BundleApplicationDetails' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BundleApplicationDetails: type: object description: "The bundle application details model.\n " additionalProperties: false properties: carrierCodes: type: array description: "The list of applicable carrier codes.\n " nullable: true items: type: string productClasses: type: array description: "The list of applicable product classes.\n " nullable: true items: type: string classesOfService: type: array description: "The list of applicable classes of service.\n " nullable: true items: type: string IJsonResponseOfIListOfBundleAvailability: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BundleAvailability' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BundleAvailability: type: object description: "Model containing the bundle ssr availability information.\n \ \ " additionalProperties: false properties: bundleCode: type: string description: "The bundle code.\n " maxLength: 4 minLength: 0 nullable: true serviceBundleType: description: "The type of the bundle\n " $ref: '#/components/schemas/ServiceBundleType' hasPrice: type: boolean description: "Indicates if the bundle has a cost associated with it.\n \ \ " pricesByJourney: type: object description: "The available in-state booking bundle prices per journey.\n\ \ " nullable: true additionalProperties: $ref: '#/components/schemas/BundlePricesByJourney' BundlePricesByJourney: type: object description: "The bundle prices by journey model.\n " additionalProperties: false properties: journeyKey: type: string description: "The journey key associated with the bundle prices.\n \ \ " nullable: true prices: type: array description: "The bundle price availabilities.\n " nullable: true items: $ref: '#/components/schemas/BundlePriceAvailability' BundlePriceAvailability: type: object description: "The bundle price availability model.\n " additionalProperties: false properties: totalPrice: type: number description: "The total price for the service bundle, minus taxes.\nIncludes\ \ any fees associated with the bundle.\n " format: decimal taxTotal: type: number description: "The total sales taxes that are applicable to the\nservice\ \ bundle.\n " format: decimal feePrice: type: number description: "The fee price associated with the bundle if there is any.\n\ \ " format: decimal passengerType: type: string description: "The passenger type that is applicable to the service\nbundle.\n\ \ " maxLength: 4 minLength: 0 nullable: true program: description: "The program details that are applicable to the service\nbundle.\n\ \ " nullable: true $ref: '#/components/schemas/BundleProgramDetails' inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the\ \ service bundle.\n " format: decimal includedSsrs: type: array description: "The included ssr availability.\n " nullable: true items: $ref: '#/components/schemas/IncludedSsrAvailability' upgradableSsrs: type: array description: "The upgradable bundle ssr availability.\n " nullable: true items: $ref: '#/components/schemas/UpgradableSsrAvailability' additionalSsrs: type: array description: "The additional bundle ssr availability.\n " nullable: true items: $ref: '#/components/schemas/AdditionalSsrAvailability' inBundleSeat: description: "The in-bundle seat information.\n " nullable: true $ref: '#/components/schemas/InBundleSeatAvailability' IncludedSsrAvailability: type: object description: "The included ssr availability model.\n " additionalProperties: false properties: bundleSsrPrice: type: number description: "The total price of the applied fee.\n " format: decimal taxTotal: type: number description: "The applied sales tax.\n " format: decimal inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the\ \ service bundle ssr.\n " format: decimal ssrCode: type: string description: "The ssr code for the in-bundle ssr availability.\n \ \ " nullable: true legSsrs: type: array description: "The available bundle leg ssrs.\n " nullable: true items: $ref: '#/components/schemas/BundleLegSsr' segmentSsrs: type: array description: "The available bundle segment ssrs.\n " nullable: true items: $ref: '#/components/schemas/BundleSegmentSsr' journeySsr: description: "The available bundle journey ssr.\n " nullable: true $ref: '#/components/schemas/BundleJourneySsr' segmentKey: type: string description: "The segment key where the SSR availability pricing applies.\n\ \ " nullable: true BundleLegSsr: type: object description: "Model information for a bundle sell service request (SSR) tied\ \ to a specific leg.\n " additionalProperties: false properties: ssrCode: type: string description: "The unique code for the SSR.\n " nullable: true passengersAvailability: type: object description: "The passengers to which this SSR is available.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/PassengerSsrAvailability' ssrType: description: "Indicates the type of SSR.\n " $ref: '#/components/schemas/SsrType' name: type: string description: "Short description or name of the SSR.\n " nullable: true limitPerPassenger: type: integer description: "Indicates how many SSRs is allowed per passenger.\n \ \ " format: int32 available: type: integer description: "The number of SSRs available.\n " format: int32 nullable: true inventoryControlled: type: boolean description: "Indicates if the SSR is inventory controlled.\n \ \ " seatDependent: type: boolean description: "Indicates if the SSR is seat-dependent.\n " feeCode: type: string description: "The fee code associated with the SSR.\n " nullable: true nest: type: string description: "The SSR nest.\n " nullable: true seatRestriction: description: "Indicates the seat restriction for the SSR.\n " $ref: '#/components/schemas/SeatRestriction' legKey: type: string description: "The unique identifier for the leg.\n " nullable: true legDetails: description: "The leg's market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' PassengerSsrAvailability: type: object description: "Model containing the details about the availability and price\ \ of the Ssr for a specific passenger.\n " additionalProperties: false properties: ssrKey: type: string description: "The Ssr key that identifies the ssr, passenger and trip information.\n\ Note this key does not equal the SSR key on the booking. The availability\ \ key contains the ssr number that is\nhelpful in some creation requests\ \ as well as a less accurate departure date.\n " nullable: true passengerKey: type: string description: "The passenger key.\n " nullable: true price: type: number description: "Gets the SSR price.\n " format: decimal BundleSegmentSsr: type: object description: "Model information for a bundle sell service request (SSR) tied\ \ to a specific segment.\n " additionalProperties: false properties: ssrCode: type: string description: "The unique code for the SSR.\n " nullable: true passengersAvailability: type: object description: "The passengers to which this SSR is available.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/PassengerSsrAvailability' ssrType: description: "Indicates the type of SSR.\n " $ref: '#/components/schemas/SsrType' name: type: string description: "Short description or name of the SSR.\n " nullable: true limitPerPassenger: type: integer description: "Indicates how many SSRs is allowed per passenger.\n \ \ " format: int32 available: type: integer description: "The number of SSRs available.\n " format: int32 nullable: true inventoryControlled: type: boolean description: "Indicates if the SSR is inventory controlled.\n \ \ " seatDependent: type: boolean description: "Indicates if the SSR is seat-dependent.\n " feeCode: type: string description: "The fee code associated with the SSR.\n " nullable: true nest: type: string description: "The SSR nest.\n " nullable: true seatRestriction: description: "Indicates the seat restriction for the SSR.\n " $ref: '#/components/schemas/SeatRestriction' segmentKey: type: string description: "The unique identifier for the segment.\n " nullable: true segmentDetails: description: "The segment market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' BundleJourneySsr: type: object description: "Model information for a bundle sell service request (SSR) tied\ \ to a specific journey.\n " additionalProperties: false properties: ssrCode: type: string description: "The unique code for the SSR.\n " nullable: true passengersAvailability: type: object description: "The passengers to which this SSR is available.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/PassengerSsrAvailability' ssrType: description: "Indicates the type of SSR.\n " $ref: '#/components/schemas/SsrType' name: type: string description: "Short description or name of the SSR.\n " nullable: true limitPerPassenger: type: integer description: "Indicates how many SSRs is allowed per passenger.\n \ \ " format: int32 available: type: integer description: "The number of SSRs available.\n " format: int32 nullable: true inventoryControlled: type: boolean description: "Indicates if the SSR is inventory controlled.\n \ \ " seatDependent: type: boolean description: "Indicates if the SSR is seat-dependent.\n " feeCode: type: string description: "The fee code associated with the SSR.\n " nullable: true nest: type: string description: "The SSR nest.\n " nullable: true seatRestriction: description: "Indicates the seat restriction for the SSR.\n " $ref: '#/components/schemas/SeatRestriction' journeyKey: type: string description: "The unique identifier for the journey.\n " nullable: true journeyDetails: description: "The journey's market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' UpgradableSsrAvailability: type: object description: "The upgradable bundle ssr availability model.\n " additionalProperties: false properties: upgradeFromSsrCode: type: string description: "The ssr code that was upgraded.\n " maxLength: 4 minLength: 0 nullable: true ssrCode: type: string description: "The ssr code.\n " maxLength: 4 minLength: 0 nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true discountPercent: type: number description: "The discount percent.\n " format: decimal maximum: 1.0 minimum: 0.0 ssrNumber: type: integer description: "The SSR number.\n " isFeeWaived: type: boolean description: "Indicates if the service fee is waived.\n " amounts: type: array description: "The service bundle SSR discount amounts.\n " nullable: true items: $ref: '#/components/schemas/BundleDiscountAmount' legSsrs: type: array description: "The available bundle leg ssrs.\n " nullable: true items: $ref: '#/components/schemas/BundleLegSsr' segmentSsrs: type: array description: "The available bundle segment ssrs.\n " nullable: true items: $ref: '#/components/schemas/BundleSegmentSsr' journeySsr: description: "The available bundle journey ssr.\n " nullable: true $ref: '#/components/schemas/BundleJourneySsr' BundleDiscountAmount: type: object description: "The discount amount details for an SSR bundle.\n " additionalProperties: false properties: currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The discount amount.\n " format: decimal ssrNumber: type: integer description: "The SSR number.\n " AdditionalSsrAvailability: type: object description: "The additional ssr availability model.\n " additionalProperties: false properties: ssrCode: type: string description: "The ssr code.\n " maxLength: 4 minLength: 0 nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true discountPercent: type: number description: "The discount percent.\n " format: decimal maximum: 1.0 minimum: 0.0 ssrNumber: type: integer description: "The SSR number.\n " isFeeWaived: type: boolean description: "Indicates if the service fee is waived.\n " amounts: type: array description: "The service bundle SSR discount amounts.\n " nullable: true items: $ref: '#/components/schemas/BundleDiscountAmount' legSsrs: type: array description: "The available bundle leg ssrs.\n " nullable: true items: $ref: '#/components/schemas/BundleLegSsr' segmentSsrs: type: array description: "The available bundle segment ssrs.\n " nullable: true items: $ref: '#/components/schemas/BundleSegmentSsr' journeySsr: description: "The available bundle journey ssr.\n " nullable: true $ref: '#/components/schemas/BundleJourneySsr' InBundleSeatAvailability: type: object description: "In-bundle seat availability model.\n " additionalProperties: false properties: seatGroup: type: string description: "The applicable seat group.\n " nullable: true bundleSsrPrice: type: number description: "The total price of the applied fee.\n " format: decimal taxTotal: type: number description: "The applied sales tax.\n " format: decimal inclusiveTaxTotal: type: number description: "The total sales inclusive taxes that are applicable to the\ \ service bundle ssr.\n " format: decimal BundleAvailabilityRequest: type: object description: "Represents a bundle availability request.\n " additionalProperties: false properties: bundleCode: type: string description: "The optional bundle code to look for.\n " maxLength: 4 minLength: 0 nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true journeyKey: type: string description: "The optional journey key to get bundle availability for.\n\ \ " nullable: true residentCountry: type: string description: "The country of residence for the passengers.\n " maxLength: 2 minLength: 0 nullable: true sourceOrganization: type: string description: "The organization to use when evaluating availability of private\ \ fares (ATPCO faring\ncategory 15).\n " maxLength: 10 minLength: 0 nullable: true passengerKeys: type: array description: "The passenger keys for the bundle availability requests.\n\ \ " nullable: true items: type: string filterBundles: type: boolean description: "A flag to indicate if the results should be filtered such\ \ that only\nbundles with ssr availability will be returned.\n \ \ " BundleResellRequest: type: object description: "The bundle resell request.\n " additionalProperties: false properties: journeyKey: type: string description: "Journey to resell the previously cancelled SSR bundles on.\n\ \ " nullable: true passengerKeys: type: array description: "A list of passengers to resell the SSR bundle for.\n \ \ " nullable: true items: type: string IJsonResponseOfIListOfBundleApplication: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BundleApplication' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BundleApplication: type: object description: "The bundle application model.\n " additionalProperties: false properties: bundleApplicationKey: type: string description: "The bundle application key.\n " nullable: true bundleSetCode: type: string description: "The code of the bundle set to which the\nbundle application\ \ applies.\n " nullable: true regionFilter: description: "The details related to the region filter for the bundle application.\n\ \ " nullable: true $ref: '#/components/schemas/RegionFilter' passengerCounts: description: "The minimum and maximum passenger counts.\n " nullable: true $ref: '#/components/schemas/DataRange' travelMinutes: description: "The minimum and maximum travel minutes.\n " nullable: true $ref: '#/components/schemas/DataRange' advancedPurchaseHours: description: "The minimum and maximum advanced purchase hours.\n \ \ " nullable: true $ref: '#/components/schemas/DataRange' dates: description: "The important dates associated with a bundle application.\n\ \ " nullable: true $ref: '#/components/schemas/BundleDates' appliesToAllSegments: type: boolean description: "Indicates if the service bundle applies to all segments or\ \ not.\n " codeShareType: type: string description: "The code share type.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 nullable: true sequenceNumber: type: integer description: "The sequence number.\n " RegionFilter: type: object description: "The region filter model.\n " additionalProperties: false properties: origin: description: "The details related to the region of origin for the bundle\ \ application.\n " nullable: true $ref: '#/components/schemas/RegionIdentifier' destination: description: "The details related to the destination region for the bundle\ \ application.\n " nullable: true $ref: '#/components/schemas/RegionIdentifier' RegionIdentifier: type: object description: "The region identifier model.\n " additionalProperties: false properties: regionTypeCode: type: string description: "The region type code.\n " maxLength: 5 minLength: 0 nullable: true regionType: description: "The region type.\n " $ref: '#/components/schemas/RegionType' exclude: type: boolean description: "The flag to indicate if this is not in the travel region.\n\ \ " nullable: true DataRange: type: object description: "The data range model.\n " additionalProperties: false properties: minimum: type: integer description: "The minimum range.\n " nullable: true maximum: type: integer description: "The maximum range.\n " nullable: true BundleDates: type: object description: "The bundle dates model.\n " additionalProperties: false properties: effective: type: string description: "The start date when the bundle application is effective.\n\ \ " format: date-time nullable: true effectiveSales: type: string description: "The effective sales date.\n " format: date-time nullable: true discontinue: type: string description: "The date when the bundle application is discontinued.\n \ \ " format: date-time nullable: true discontinueSales: type: string description: "The discontinued sales date.\n " format: date-time nullable: true IJsonResponseOfBundleSetDetails: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BundleSetDetails' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BundleSetDetails: type: object description: "The bundle set details model.\n " additionalProperties: false properties: bundleCodes: type: array description: "The list of bundle codes associated with the bundle set.\n\ \ " nullable: true items: type: string BundleSellRequest: type: object description: "The bundle sell request.\n " additionalProperties: false required: - bundleCode properties: bundleCode: type: string description: "The bundle code to sell.\n " maxLength: 4 minLength: 0 passengerKeys: type: array description: "A list of passengers to sell the bundle for.\n " nullable: true items: type: string upgradeRequest: description: "The optional ssr upgrade request. If left blank,\nthe default\ \ bundle ssr(s) will be sold (if available).\n " nullable: true $ref: '#/components/schemas/SsrByKeysRequestv2' SsrByKeysRequestv2: type: object description: "Request to add a leg, segment, or journey Ssr.\n " additionalProperties: false required: - keys properties: keys: type: array description: "Keys for the request.\n " items: $ref: '#/components/schemas/SsrByKeyRequest' forceWaveOnSell: type: boolean description: "Force wave on sell. Default value is false.\n " nullable: true currencyCode: type: string description: "Set the Currency Code if different than the booking currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true feePricingMode: description: "Indicates whether the SSR is meant to be sold in points or\ \ in currency.\n " nullable: true $ref: '#/components/schemas/FeePricingMode' SsrByKeyRequest: type: object description: "SSR detail for a specific passenger number.\n " additionalProperties: false required: - ssrKey properties: ssrKey: type: string description: "The Ssr key.\n " minLength: 1 count: type: integer description: "The number of items to include. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true note: type: string description: "Notes associated with this Ssr.\n " nullable: true IJsonResponseOfIListOfString: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: type: string errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareOverrideRequest: type: object description: "Defines a fare override.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The new fare amount.\n " format: decimal overridePublishedPrice: type: boolean description: "Whether the price being overridden is a published price or\ \ a discounted price\n " nullable: true MoveJourneyRequest: type: object description: "Defines the move journey request.\n " deprecated: true x-deprecatedMessage: 4.5.3 - Please use MoveJourneyRequestv2 instead. additionalProperties: false required: - fromJourneyKey - toJourneyKey - fareKey properties: fromJourneyKey: type: string description: "The key of the journey that is being moved from.\n \ \ " minLength: 1 toJourneyKey: type: string description: "The key of the journey that is being moved to.\n \ \ " minLength: 1 fareKey: type: string description: "The fare key to move to.\n " minLength: 1 standbyPriorityCode: type: string description: "Standby priority code.\n " nullable: true inventoryControlType: description: "Inventory control.\n " $ref: '#/components/schemas/InventoryControlType' changeReasonCode: description: "Change reason code.\n " $ref: '#/components/schemas/StatelessChangeReasonCodes' bookingComment: type: string description: "A comment to be added to the effected booking.\n \ \ " nullable: true adHocConnection: type: boolean description: "Flag representing if an ad hoc connection is needed.\n \ \ " adHocIsForGeneralUse: type: boolean description: "Flag that sets the \"For General Use\" setting when creating\ \ an ad hoc connection.\n " StatelessChangeReasonCodes: type: integer description: "Specifies the change reason code for a stateless booking.\n \ \ \n\n0 = Irop\n1 = ScheduleChange\n2 = Move\n3 = VoluntaryFlyAhead\n\ 4 = InvoluntaryFlyAhead" x-enumNames: - Irop - ScheduleChange - Move - VoluntaryFlyAhead - InvoluntaryFlyAhead enum: - 0 - 1 - 2 - 3 - 4 AdHocMoveJourneyRequest: type: object description: "Defines the ad hoc move journey request.\n " additionalProperties: false required: - fromJourneyKey - toJourneyKeys properties: fromJourneyKey: type: string description: "The key of the journey that is being moved from.\n \ \ " minLength: 1 toJourneyKeys: type: array description: "The list of ad hoc keys of the journeys that are potentially\ \ being moved to. The API will combine the segments\nfrom these journeys\ \ into one journey and pass that to NewSkies, but will do no other validation\ \ to ensure the ad\nhoc connection will work. The end user is responsible\ \ for ensuring the ad hoc connection is valid.\n " items: type: string fareKey: type: string description: "The optional fare key to move to.\n " nullable: true standbyPriorityCode: type: string description: "Standby priority code.\n " nullable: true inventoryControlType: description: "Inventory control.\n " $ref: '#/components/schemas/InventoryControlType' changeReasonCode: description: "Change reason code.\n " $ref: '#/components/schemas/StatelessChangeReasonCodes' bookingComment: type: string description: "A comment to be added to the effected booking.\n \ \ " nullable: true adHocIsForGeneralUse: type: boolean description: "Flag that sets the \"For General Use\" setting when creating\ \ an ad hoc connection.\n " IJsonResponseOfIListOfBookingQueue: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BookingQueue' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingQueue: type: object description: "The booking queue model.\n " additionalProperties: false properties: bookingQueueKey: type: string description: "The booking queue key.\n " nullable: true notes: type: string description: "A summary on why the booking was placed in the queue.\n \ \ " maxLength: 128 minLength: 0 nullable: true type: description: "The type of event that triggered placement of the booking\ \ in the queue.\n " $ref: '#/components/schemas/QueueEventType' watchListKey: type: string description: "The watch list key.\n " nullable: true details: type: array description: "The list of booking queue details.\n " nullable: true items: $ref: '#/components/schemas/BookingQueueDetail' BookingQueueDetail: type: object description: "The detail in a booking queue model.\n " additionalProperties: false properties: bookingQueueDetailKey: type: string description: "The booking queue detail key.\n " nullable: true detail: type: string description: "The booking queue detail.\n " nullable: true passengerAlternateKey: type: string description: "The detail passenger alternate key.\n " nullable: true passengerTicketInfo: description: "The passenger ticket info detail.\n " nullable: true $ref: '#/components/schemas/PassengerTicketInfo' PassengerTicketInfo: type: object description: "Represents detailed information for an e-ticket assigned to a\ \ passenger.\n " additionalProperties: false properties: status: description: "Ticket status.\n " $ref: '#/components/schemas/TicketStatusCode' ticketIndicator: type: string description: "Ticket indicator.\n " nullable: true passengerCouponCount: type: integer description: "Number of passenger coupons affected.\n " format: int32 infantPassengerCouponCount: type: integer description: "Number of infant passenger coupons affected.\n " format: int32 BookingQueuesRequest: type: object description: "The booking request base model for retrieving booking queues.\n\ \ " additionalProperties: false properties: password: type: string description: "The Password needed to access the queue. Required if queue\n\ is set to password-protected in Sky Manager.\n " nullable: true passengerKey: type: string description: "The unique passenger identifier key.\n " nullable: true segmentKey: type: string description: "The unique segment key.\n " nullable: true QueueBookingByInventoryLegRequest: type: object description: "The queue booking by inventory leg request model\n " additionalProperties: false required: - legKey - bookingQueueCodes - comments properties: legKey: type: string description: "The leg key of the inventory which the bookings to be queued\ \ belongs to.\n " minLength: 1 bookingQueueCodes: type: array description: "The collection of booking queue codes to enqueue the bookings\ \ to.\n " items: type: string comments: type: string description: "Additional information for the queue operation.\n \ \ " minLength: 1 IJsonResponseOfIListOfWatchListResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/WatchListResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' WatchListResponse: type: object description: "The watch list response.\n " additionalProperties: false properties: referenceNumber: type: string description: "The watch list match criteria reference number.\n \ \ " nullable: true watchListKey: type: string description: "The watch list key.\n " nullable: true watchListPersonKey: type: string description: "The watch list person key.\n " nullable: true matchKey: type: string description: "A key matching an API key depending on the MatchKeyType.\n\ \ " nullable: true matchKeyType: description: "An enum indicating which API key MatchKey matches.\n \ \ " $ref: '#/components/schemas/MatchKeyType' matchDetail: type: string description: "The details of the person matched.\n " nullable: true matchType: description: "What the person was matched by.\n " $ref: '#/components/schemas/MatchType' matchCode: type: string description: "The match code.\n " nullable: true MatchKeyType: type: integer description: "The match key type enumeration.\n \n\n0 = Default\n\ 1 = PassengerAlternateKey\n2 = ContactTypeCode\n3 = PaymentKey" x-enumNames: - Default - PassengerAlternateKey - ContactTypeCode - PaymentKey enum: - 0 - 1 - 2 - 3 MatchType: type: integer description: "Match list enumeration.\n \n\n0 = Default\n1 = PaymentAccountNumber\n\ 2 = ContactEmailAddress\n3 = ContactPhone\n4 = ContactFullName\n5 = ContactLastNameFirstInitial\n\ 6 = ContactFullAddress\n7 = ContactAddress\n8 = PassengerDOB\n9 = PassengerFullName\n\ 10 = PassengerLastName\n11 = TravelDocNumber\n12 = TravelDocFullName\n13 =\ \ TravelDocLastName" x-enumNames: - Default - PaymentAccountNumber - ContactEmailAddress - ContactPhone - ContactFullName - ContactLastNameFirstInitial - ContactFullAddress - ContactAddress - PassengerDOB - PassengerFullName - PassengerLastName - TravelDocNumber - TravelDocFullName - TravelDocLastName enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 IJsonResponseOfIListOfWatchListPerson: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/WatchListPerson' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' WatchListPerson: type: object description: "The watch list person.\n " additionalProperties: false properties: watchListPersonKey: type: string description: "The watch list person key.\n " nullable: true names: type: array description: "The watch list person name list.\n " nullable: true items: $ref: '#/components/schemas/WatchListPersonName' addresses: type: array description: "The watch list person address list.\n " nullable: true items: $ref: '#/components/schemas/Address' phoneNumbers: type: array description: "The watch list person phone list.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' emails: type: array description: "The watch list person email list.\n " nullable: true items: $ref: '#/components/schemas/EmailCreateRequest' payments: type: array description: "The watch list person payment list.\n " nullable: true items: $ref: '#/components/schemas/WatchListPersonPayment' travelDocuments: type: array description: "The watch list person travel document list.\n " nullable: true items: $ref: '#/components/schemas/WatchListPersonTravelDocument' information: type: array description: "The watch list person information list.\n " nullable: true items: type: string comments: type: array description: "The watch list person comment list.\n " nullable: true items: type: string dateOfBirth: type: string description: "The passenger's date of birth.\n " format: date-time nullable: true gender: description: "Person gender.\n " $ref: '#/components/schemas/Gender' birthCountry: type: string description: "The person's birth country.\n " nullable: true nationality: type: string description: "The person nationality.\n " nullable: true watchListKey: type: string description: "The key of the watch list the person is on.\n " nullable: true declaredGender: type: string description: "The watchlist person's declared gender. A value of \"F\" is\ \ mapped to a female binary gender. All other values will\nbe mapped to\ \ a male binary gender.\n " nullable: true WatchListPersonName: type: object description: "The watch list person name.\n " additionalProperties: false properties: name: description: "The watch list person name.\n " nullable: true $ref: '#/components/schemas/Name' nameType: description: "The watch list person name type.\n " $ref: '#/components/schemas/NameType' dateOfBirth: type: string description: "The watch list person date of birth.\n " format: date-time nullable: true NameType: type: integer description: "Specifies the name type to define the true name for a person or\ \ an alias.\n \n\n0 = True\n1 = Alias\n2 = Variant" x-enumNames: - 'True' - Alias - Variant enum: - 0 - 1 - 2 EmailCreateRequest: type: object description: "Defines the person email create address.\n " additionalProperties: false required: - email - type properties: email: type: string description: "The email address value.\n " maxLength: 266 minLength: 0 default: type: boolean description: "Flag indicating if the email is the default.\n " type: type: string description: "The type code of the email address.\nPlease note that this\ \ should be a char and not a string.\n " maxLength: 1 minLength: 1 WatchListPersonPayment: type: object description: "The watch list person form of payment.\n " additionalProperties: false properties: accountNumber: type: string description: "The watch list person payment account number.\n \ \ " nullable: true paymentMethodCode: type: string description: "The watch list person payment method code.\n " nullable: true WatchListPersonTravelDocument: type: object description: "The watch list person travel document.\n " additionalProperties: false properties: name: description: "The watch list person name.\n " nullable: true $ref: '#/components/schemas/Name' number: type: string description: "The watch list person travel document number.\n \ \ " nullable: true documentTypeCode: type: string description: "The watch list person travel document type code.\n \ \ " nullable: true IJsonResponseOfWatchListPerson: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/WatchListPerson' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfAllPagedWatchListPersonResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AllPagedWatchListPersonResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AllPagedWatchListPersonResponse: type: object description: "The watch list person.\n " additionalProperties: false properties: persons: type: object description: "The watch list response mapped by watch list key to a list\ \ of person results.\n " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/WatchListPerson' lastPageKey: type: string description: "The last page key. Will be null if it is the last page.\n\ \ " nullable: true BookingsCommentRequest: type: object description: "Defines a booking comment.\n " additionalProperties: false properties: type: description: "Indicates where the comment will be seen.\n " $ref: '#/components/schemas/CommentType' text: type: string description: "The text of the comment.\n " maxLength: 1024 minLength: 0 nullable: true createdDate: type: string description: "The created date of the comment.\n " format: date-time nullable: true BookingQueueRequestv2: type: object description: "The booking queue request v2 model.\n " additionalProperties: false required: - queueCode properties: queueCode: type: string description: "The code for the booking queue.\n " maxLength: 6 minLength: 0 notes: type: string description: "The notes for the booking request.\n " nullable: true password: type: string description: "The Password needed to access the queue. Required if queue\n\ is set to password-protected in Sky Manager.\n " nullable: true IJsonResponseOfItineraryQuote: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ItineraryQuote' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ItineraryQuote: type: object description: "Defines the itinerary quote model.\n " additionalProperties: false properties: passengers: type: object description: "The dictionary of passengers.\n " nullable: true additionalProperties: $ref: '#/components/schemas/Passenger' journeys: type: array description: "The list of journeys.\n " nullable: true items: $ref: '#/components/schemas/Journey' breakdown: description: "The itinerary pricing breakdown.\n " nullable: true $ref: '#/components/schemas/BookingPriceBreakdown' ItineraryQuoteRequest: type: object description: "Defines the itinerary booking quote request.\n " additionalProperties: false required: - passengers - currencyCode properties: keys: type: array description: "The list of selected sell keys to be added to the booking.\n\ \ " nullable: true items: $ref: '#/components/schemas/SellKey' passengers: description: "The list of passengers.\n " $ref: '#/components/schemas/PassengerTypeCriteria' currencyCode: type: string description: "The desired currency code.\n " maxLength: 3 minLength: 1 infantCount: type: integer description: "The number of infants to be added.\n " format: int32 nullable: true promotionCode: type: string description: "The promo code to apply.\n " maxLength: 8 minLength: 0 nullable: true sourceOrganization: type: string description: "The acting source organization code.\n " maxLength: 10 minLength: 0 nullable: true ssrs: type: array description: "Sell service requests to quote.\n " nullable: true items: $ref: '#/components/schemas/SsrsStatelessRequest' serviceBundleCodes: type: array description: "Optional list of bundle codes from a specific fare of a flight\ \ to be included in the booking quote if\n`IncludeServiceBundle` is set\ \ to `Yes`.\n " nullable: true items: type: string includeServiceBundle: type: boolean description: "Determines whether to include bundles in the booking quote.\n\ \ " nullable: true PassengerTypeCriteria: type: object description: "Defines the availability criteria passenger types.\n \ \ " additionalProperties: false required: - types properties: types: type: array description: "The list of passenger types and counts.\n " items: $ref: '#/components/schemas/PassengerSearchCriteria' residentCountry: type: string description: "The passenger resident country.\n " maxLength: 2 minLength: 0 nullable: true PassengerSearchCriteria: type: object description: "Model representing an passenger group type for availability search.\n\ \ " additionalProperties: false required: - type - count properties: type: type: string description: "The passenger type code.\n " maxLength: 4 minLength: 0 discountCode: type: string description: "The discount code to be applied.\n " maxLength: 4 minLength: 0 nullable: true count: type: integer description: "The number of passenger for the type.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 SsrsStatelessRequest: type: object description: "Ssrs by type model allows multiple Ssr requests for a specific\ \ type.\n " additionalProperties: false required: - market properties: market: description: "Market for the segment.\n " $ref: '#/components/schemas/MarketInformation' items: type: array description: "SSR request items.\n " nullable: true items: $ref: '#/components/schemas/SsrRequestByPassengerType' SsrRequestByPassengerType: type: object description: "SSR request for a single passenger type.\n " additionalProperties: false required: - passengerType properties: passengerType: type: string description: "The passenger type.\n " maxLength: 4 minLength: 0 ssrs: type: array description: "The Ssr code.\n " nullable: true items: $ref: '#/components/schemas/SsrDesignatorRequest' SsrDesignatorRequest: type: object description: "SSR request for a Ssr designator request.\n " additionalProperties: false required: - ssrCode properties: ssrCode: type: string description: "The Ssr code.\n " minLength: 1 count: type: integer description: "The number of items to include. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true designator: description: "The designator if different than the segment. This will only\ \ be passed to select a unique leg on flights with\nmultiple legs.\n \ \ " nullable: true $ref: '#/components/schemas/MarketDesignator' BookingQueueDeleteRequest: type: object description: "The booking queue delete request.\n " additionalProperties: false required: - queueCode - authorizedBy properties: queueCode: type: string description: "The code for the booking queue.\n " maxLength: 6 minLength: 0 notes: type: string description: "The notes for the booking request.\n " nullable: true password: type: string description: "The Password needed to access the queue. Required if queue\n\ is set to password-protected in Sky Manager.\n " nullable: true authorizedBy: type: string description: "The authorizing agent.\n " minLength: 1 MoveJourneyRequestv2: type: object description: "Defines the move journey request, version two.\n " additionalProperties: false required: - fromJourneyKey - toJourneyKeys - fareKey properties: fromJourneyKey: type: string description: "The key of the journey that is being moved from.\n \ \ " minLength: 1 toJourneyKeys: type: array description: "The list of keys of the journeys that are potentially being\ \ moved to.\n " items: type: string fareKey: type: string description: "The fare key to move to.\n " minLength: 1 standbyPriorityCode: type: string description: "Standby priority code.\n " nullable: true inventoryControlType: description: "Inventory control.\n " $ref: '#/components/schemas/InventoryControlType' changeReasonCode: description: "Change reason code.\n " $ref: '#/components/schemas/StatelessChangeReasonCodes' bookingComment: type: string description: "A comment to be added to the effected booking.\n \ \ " nullable: true IJsonResponseOfRetrieveBookingQueueResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/RetrieveBookingQueueResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' RetrieveBookingQueueResponse: type: object description: "The booking queue response for retrieving booking queue items.\n\ \ " additionalProperties: false properties: lastIndex: type: integer description: "The last row id retrieved.\n " format: int64 retrieveBookingQueueResponseItems: type: array description: "The list of booking queue response items.\n " nullable: true items: $ref: '#/components/schemas/RetrieveBookingQueueResponseItem' RetrieveBookingQueueResponseItem: type: object description: "The booking queue response items for retrieving booking queue\ \ items.\n " additionalProperties: false properties: recordLocator: type: string description: "The record locator.\n " nullable: true bookingQueueRestriction: description: "The queue restriction.\n " $ref: '#/components/schemas/BookingQueueRestriction' queueCode: type: string description: "The queue code.\n " nullable: true notes: type: string description: "The notes.\n " nullable: true inProgress: type: boolean description: "The call status.\n " priorityDate: type: string description: "The priority date.\n " format: date-time domainCode: type: string description: "The domain code.\n " nullable: true queueEventType: description: "The queue event type.\n " $ref: '#/components/schemas/QueueEventType' BookingQueueRestriction: type: integer description: "Defines the restrictions associated with a BookingQueue\n \ \ \n\n0 = Restricted\n1 = AddAllowedOnly\n2 = Allowed" x-enumNames: - Restricted - AddAllowedOnly - Allowed enum: - 0 - 1 - 2 IJsonResponseOfPagedWatchListPersonResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PagedWatchListPersonResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PagedWatchListPersonResponse: type: object description: "The watch list person.\n " additionalProperties: false properties: persons: type: array description: "The watch list person name list.\n " nullable: true items: $ref: '#/components/schemas/WatchListPerson' lastPageKey: type: string description: "The last page key. Will be null if it is the last page.\n\ \ " nullable: true IJsonResponseOfFareRule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FareRule' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PrintItineraryRequest: type: object description: "Defines the print itinerary request model.\n " additionalProperties: false required: - printerCode properties: printerCode: type: string description: "The printer code.\n " minLength: 1 numberOfCopies: type: integer description: "The number of copies.\nDefaults to 1 if not specified.\n \ \ " format: int32 maximum: 2147483647.0 minimum: 1.0 nullable: true IJsonResponseOfBookingPenalty: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BookingPenalty' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingPenalty: type: object description: "Defines booking penalty.\n " additionalProperties: false properties: journeyPenalties: type: array description: "The journey penalties.\n " nullable: true items: $ref: '#/components/schemas/JourneyPenalty' JourneyPenalty: type: object description: "Defines journey penalty.\n " additionalProperties: false properties: appliedFeeType: description: "The applied fee type.\n " $ref: '#/components/schemas/PenaltyFeeType' cancelPenaltyFeeInfo: description: "The cancel penalty fee info.\n " nullable: true $ref: '#/components/schemas/PenaltyFeeTypeInfo' changePenaltyFeeInfo: description: "The change penalty fee info.\n " nullable: true $ref: '#/components/schemas/PenaltyFeeTypeInfo' movePenaltyFeeInfo: description: "The move penalty fee info.\n " nullable: true $ref: '#/components/schemas/PenaltyFeeTypeInfo' changeAllowed: type: boolean description: "The change allowed.\n " collectedCurrencyCode: type: string description: "The collected currency code.\n " nullable: true feeWaived: type: boolean description: "The flag indicating whether fee is waived.\n " infantCancelFees: type: array description: "The infant cancel fees.\n " nullable: true items: $ref: '#/components/schemas/PassengerFee' infantChangeFees: type: array description: "The infant change fees.\n " nullable: true items: $ref: '#/components/schemas/PassengerFee' infantMoveFees: type: array description: "The infant move fees.\n " nullable: true items: $ref: '#/components/schemas/PassengerFee' journeyKey: type: string description: "The journey key.\n " nullable: true minimumPassengers: type: integer description: "The minimum passengers.\n " spoilageWaived: type: boolean description: "The spoilage waived flag.\n " PenaltyFeeType: type: integer description: "Enumeration representing all the different penalty fee types.\n\ \ \n\n0 = None\n1 = Change\n2 = Cancel\n3 = Move" x-enumNames: - None - Change - Cancel - Move enum: - 0 - 1 - 2 - 3 PenaltyFeeTypeInfo: type: object description: "Defines penalty fee type info.\n " additionalProperties: false properties: feeApplication: description: "The cancel fee application.\n " $ref: '#/components/schemas/FeeApplication' passengerFees: type: array description: "The cancel fees.\n " nullable: true items: $ref: '#/components/schemas/PassengerFee' penaltyType: description: "The cancel penalty type.\n " $ref: '#/components/schemas/PenaltyType' PenaltyType: type: integer description: "Enumeration representing all the different penalty types.\n \ \ \n\n0 = None\n1 = WithFee\n2 = NonRefundable" x-enumNames: - None - WithFee - NonRefundable enum: - 0 - 1 - 2 PriceRequest: type: object description: "Defines price request.\n " additionalProperties: false properties: forceRefareItinerary: type: boolean description: "Set to true to force the system to select new fares for all\ \ journeys -- including those for which a fare has\nalready been applied.\n\ \ " buildConnections: type: boolean description: "When set to true, unpriced journeys will be combined with\ \ other journeys in the PNR, given that the connection\nexists in schedule\ \ and is priceable.\n " sourceBookingPointOfSale: description: "The source booking point of sale to use. If set, the booking's\ \ source point of sale will be updated to the\nspecified value, and will\ \ be used for evaluation of fare sales restrictions, tax rules that require\ \ the\norganization, etc. Note that updating the source point of sale\ \ will force RefareItinerary to true.\n " nullable: true $ref: '#/components/schemas/BookingPointOfSale' typeOFSale: description: "Additional details that can drive the pricing results. Only\ \ ResidentCountry and PromotionCode will be used for\npricing decisions.\n\ \ " nullable: true $ref: '#/components/schemas/TypeOfSale' AvailabilityStandbyRequest: type: object description: "Standby availability request.\n " additionalProperties: false required: - journeyKey properties: journeyKey: type: string description: "The journey key to reference in the standby availability request.\n\ \ " minLength: 1 classControl: description: "The fare class control.\n " nullable: true $ref: '#/components/schemas/FareClassControl' numberOfFaresPerJourney: type: integer description: "The number of fares per journey to be returned. If not set,\ \ it will use the default optimized values.\n " format: int32 nullable: true returnEmptyResults: type: boolean description: "Indicates if empty results could be returned as a response.\n\ \ " nullable: true CheckinPassengersRequestv3: type: object description: "Defines the checkin passengers request v3 model.\n " additionalProperties: false required: - passengers properties: passengers: type: array description: "The collection of passengers to checkin.\n " items: $ref: '#/components/schemas/CheckinPassengerRequestv2' seatsRequired: type: boolean description: "The flag indicating whether a seat is required for checkin.\n\ \ " nullable: true skipSecurityChecks: type: boolean description: "The flag indicating whether checkin requirement validation\ \ will be skipped.\n " nullable: true CheckinPassengerRequestv2: type: object description: "Defines the individual passenger checkin request.\n \ \ " additionalProperties: false required: - passengerKey properties: passengerKey: type: string description: "The unique passenger key being checked in.\n " minLength: 1 transitType: description: "The passengers transit type.\n " nullable: true $ref: '#/components/schemas/TransitType' processApps: type: boolean description: "Flag indicating to process APPS.\n " nullable: true verifiedTravelDocumentKeys: type: array description: "The value specifying the verified travel document(s) associated\ \ with this checkin.\n " nullable: true items: type: string IJsonResponseOfCommitBookingResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CommitBookingResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CommitBookingResponse: type: object description: "The response of committing a booking, providing the record locator.\n\ \ " additionalProperties: false properties: recordLocator: type: string description: "The record locator of the booking.\n " nullable: true CommitRequestv2: type: object description: "Represents version two of the booking commit request.\n \ \ " additionalProperties: false properties: receivedBy: type: string description: "The received by name.\n " maxLength: 64 minLength: 0 nullable: true restrictionOverride: type: boolean description: "If set to true, booking will be committed even if Price is\ \ not valid, granted that agent's role\nhas permission to override.\n\ \ " hold: description: "The booking hold date.\n " nullable: true $ref: '#/components/schemas/BookingHold' notifyContacts: type: boolean description: "The notify contacts flag.\n " comments: type: array description: "The optional comments to add.\n " nullable: true items: $ref: '#/components/schemas/BookingCommentRequest' contactTypesToNotify: type: array description: "List of contact type codes for notification.\nPlease note\ \ that this is a list of chars not a list of strings.\nFor example, there\ \ is usually a primary contact represented with 'P'.\nThese are configurable\ \ so valid types will depend on your environment.\n " nullable: true items: type: string maxLength: 1 receivedReference: type: string description: "The received by reference.\n " maxLength: 20 minLength: 0 nullable: true BookingCommentRequest: type: object description: "Defines a booking comment.\n " additionalProperties: false properties: type: description: "Indicates where the comment will be seen.\n " $ref: '#/components/schemas/CommentType' text: type: string description: "The text of the comment.\n " maxLength: 1024 minLength: 0 nullable: true createdDate: type: string description: "The created date of the comment.\n " format: date-time nullable: true sendToBookingSource: type: boolean description: "The flag for triggering an outbound sync message that will\ \ be generated to\nthe booking source as an SSR OTHS element.\n \ \ " nullable: true IJsonResponseOfCategory50Responsev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Category50Responsev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Category50Responsev2: type: object description: "Represents a cat 50 response.\n " additionalProperties: false properties: title: type: string description: "The title of the category 50 fare rule information.\n \ \ " nullable: true text: type: string description: "The formatted text for the category 50 fare rule information..\n\ \ " nullable: true dataType: description: "The content data type of the text.\n " $ref: '#/components/schemas/ContentDataType' cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 nullable: true ContentDataType: type: integer description: "Defines the content data type enumeration.\n \n\n0\ \ = Default\n1 = Text\n2 = RichTextFormat\n3 = ImageJpg\n4 = ImageGif\n5 =\ \ ImageBmp\n6 = ImagePng\n7 = WordDoc\n8 = Html\n9 = Pdf\n10 = Uri\n11 = WordDocx\n\ -1 = Unmapped" x-enumNames: - Default - Text - RichTextFormat - ImageJpg - ImageGif - ImageBmp - ImagePng - WordDoc - Html - Pdf - Uri - WordDocx - Unmapped enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - -1 BookingGroupNameRequest: type: object description: "The booking group name request model.\n " additionalProperties: false properties: bookingGroupName: type: string description: "The booking group name.\n " nullable: true IJsonResponseOfNullableDateTime: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: string description: "The payload data.\n " format: date-time nullable: true errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfEquipmentBasev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/EquipmentBasev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' EquipmentBasev2: type: object description: "Represents the basic equipment information response model.\n \ \ " additionalProperties: false properties: marketInformation: description: "The market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' name: type: string description: "The name of the equipment.\n " nullable: true marketingCode: type: string description: "The market code.\n " nullable: true equipmentCategory: description: "The equipment category.\n " $ref: '#/components/schemas/EquipmentCategory' availableUnits: type: integer description: "The available units.\n " format: int32 equipmentType: type: string description: "The type of equipment for the journey.\n " maxLength: 3 minLength: 0 nullable: true equipmentTypeSuffix: type: string description: "The suffix associated with the equipment type.\n \ \ " maxLength: 3 minLength: 0 nullable: true IJsonResponseOfEquipmentBasev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/EquipmentBasev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfEquipmentv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Equipmentv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Equipmentv2: type: object description: "Represents the equipment information response model.\n \ \ " additionalProperties: false properties: marketInformation: description: "The market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' name: type: string description: "The name of the equipment.\n " nullable: true marketingCode: type: string description: "The market code.\n " nullable: true equipmentCategory: description: "The equipment category.\n " $ref: '#/components/schemas/EquipmentCategory' availableUnits: type: integer description: "The available units.\n " format: int32 equipmentType: type: string description: "The type of equipment for the journey.\n " maxLength: 3 minLength: 0 nullable: true equipmentTypeSuffix: type: string description: "The suffix associated with the equipment type.\n \ \ " maxLength: 3 minLength: 0 nullable: true properties: type: array description: "Indicates the supported seat properties in effect on this\ \ equipment.\n " nullable: true items: $ref: '#/components/schemas/SeatMapProperty' ssrs: type: array description: "Indicates the supported seat-dependent SSRs in effect on this\ \ equipment.\n " nullable: true items: type: string IJsonResponseOfEquipmentv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Equipmentv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AvailabilitySimpleRequestv2: type: object description: "Model representing an availability simple request v2.\n \ \ " additionalProperties: false required: - origin - destination - beginDate - passengers properties: origin: type: string description: "The origin station code.\n " maxLength: 3 minLength: 3 destination: type: string description: "The destination station code.\n " maxLength: 3 minLength: 3 searchDestinationMacs: type: boolean description: "Flag indicating to search destination mac stations. Note\ \ that when set to \"true\" for round-trip availability, this\nwill search\ \ the destination MAC for both journeys.\n " nullable: true searchOriginMacs: type: boolean description: "Flag indicating to search origin mac stations. Note that\ \ when set to \"true\" for round-trip availability, this will\nsearch\ \ the origin MAC for both journeys.\n " nullable: true beginDate: type: string description: "The departure date.\n " format: date-time minLength: 1 endDate: type: string description: "The return date. This date represents the return trip's selected\ \ day.\n " format: date-time nullable: true passengers: description: "The list of passengers.\n " $ref: '#/components/schemas/PassengerTypeCriteria' codes: description: "The different code criteria that can be set that can influence\ \ availability response.\n " nullable: true $ref: '#/components/schemas/AvailabilityCodeCriteriav2' filters: description: "Filters applied to the response for a single direction.\n\ \ " nullable: true $ref: '#/components/schemas/AvailabilityCriteriaFilter' taxesAndFees: description: "The taxes and fees rollup mode which affects the pricing information.\n\ \ " nullable: true $ref: '#/components/schemas/TaxesAndFeesRollupMode' ssrCollectionsMode: description: "Determines if SSR nest information will be returned on the\ \ legs for each available journey segments.\n " nullable: true $ref: '#/components/schemas/AvailabilitySsrCollectionsMode' numberOfFaresPerJourney: type: integer description: "The number of fares per journey to be returned. If not set\ \ it will use the default optimized values\n " format: int32 nullable: true returnEmptyResults: type: boolean description: "Flag determining if empty schedule responses will be returned.\n\ Defaults to false.\n " nullable: true AvailabilityRequestv3: type: object description: "Defines the availability request, version 3.\n " additionalProperties: false required: - passengers - criteria properties: passengers: description: "The list of passengers.\n " $ref: '#/components/schemas/PassengerTypeCriteriav2' criteria: type: array description: "The collection of availability search criteria.\n \ \ " items: $ref: '#/components/schemas/AvailabilityCriteria' codes: description: "The codes that can be set to further filter the availability\ \ search.\n " nullable: true $ref: '#/components/schemas/AvailabilityCodeCriteriav2' taxesAndFees: description: "The taxes and fees rollup mode which affects the pricing information.\n\ \ " nullable: true $ref: '#/components/schemas/TaxesAndFeesRollupMode' numberOfFaresPerJourney: type: integer description: "The number of fares per journey to be returned. If not set\ \ it will use the default optimized value.\n " format: int32 nullable: true returnEmptyResults: type: boolean description: "Indicates if empty schedule responses will be returned.\n\ Defaults to false.\n " nullable: true passengerCountOverride: type: integer description: "An optional parameter to control the total passenger count\ \ passed to NewSkies.\nIf this is not provided, the API will add up the\ \ individual passenger information\ndata provided on the passenger type\ \ criteria portion of the request.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 nullable: true fareValidations: type: array description: "The list of fare basis codes for troubleshooting fares and\ \ pricing restrictions.\nThis request property is only recommended to\ \ be used with Fare Manager Plus.\n " nullable: true items: type: string PassengerTypeCriteriav2: type: object description: "Defines the passenger type criteria for availability search.\n\ \ " additionalProperties: false required: - types properties: types: type: array description: "The collection of passenger types and counts.\n \ \ " items: $ref: '#/components/schemas/PassengerSearchCriteriav2' residentCountry: type: string description: "The passenger's resident country.\n " maxLength: 2 minLength: 0 nullable: true PassengerSearchCriteriav2: type: object description: "Represents the passenger group type for availability search.\n\ \ " additionalProperties: false required: - type - count properties: type: type: string description: "The passenger type code.\n " maxLength: 4 minLength: 0 discountCode: type: string description: "The discount code to be applied.\n " maxLength: 4 minLength: 0 nullable: true count: type: integer description: "The number of passenger for the type.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 details: type: array description: "The additional search criteria per passenger. The number of\ \ details in the list must match the count.\n " nullable: true items: $ref: '#/components/schemas/PassengerSearchCriteriaDetail' PassengerSearchCriteriaDetail: type: object description: "Represents the passenger details for flight availability search.\n\ \ " additionalProperties: false properties: dateOfBirth: type: string description: "The passenger's date of birth.\n " format: date-time nullable: true nationality: type: string description: "The passenger's nationality.\n " nullable: true residentCountry: type: string description: "The passenger's resident country.\n " nullable: true programCode: type: string description: "The customer program of the passenger.\n " nullable: true programLevel: type: string description: "The customer program level of the passenger.\n " nullable: true IJsonResponseOfSeatMapStatelessAvailability: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SeatMapStatelessAvailability' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SeatMapStatelessAvailability: type: object description: "Defines the equipment availability.\n " additionalProperties: false properties: seatMap: description: "The seat map.\n " nullable: true $ref: '#/components/schemas/SeatMap' ssrLookup: type: object description: "The list of SSR's available.\n " nullable: true additionalProperties: $ref: '#/components/schemas/Ssr' TripSellRequestv2: type: object description: "Defines the data needed to sell journeys to a booking.\n \ \ " additionalProperties: false required: - passengers - currencyCode properties: keys: type: array description: "The collection of selected sell keys to be added to the booking.\n\ \ " nullable: true items: $ref: '#/components/schemas/SellKey' passengers: description: "The collection of passengers.\n " $ref: '#/components/schemas/PassengerTypeCriteriav2' currencyCode: type: string description: "The desired currency code.\n " maxLength: 3 minLength: 1 infantCount: type: integer description: "The number of infants to be added.\n " format: int32 nullable: true promotionCode: type: string description: "The promo code to apply.\n " maxLength: 8 minLength: 0 nullable: true sourceOrganization: type: string description: "The acting source organization code.\n " maxLength: 10 minLength: 0 nullable: true preventOverlap: type: boolean description: "Used to explicitly control support for flight overlaps. It\ \ works together with the \u2018Allow Sell of Flight Overlap\u2019\nrole\ \ setting. Overlaps will be allowed only when PreventOverlaps is FALSE\ \ and the user has permissions to sell\noverlaps.\n " nullable: true suppressPassengerAgeValidation: type: boolean description: "Indicates if passenger and infant age validation will be skipped.\n\ \ " nullable: true loyalty: description: "Controls whether to use monetary fares, points-based fares,\ \ or both.\nDefaults to monetary only.\n " nullable: true $ref: '#/components/schemas/TripLoyaltyFilter' serviceBundleCodes: type: array description: "Optional list of bundle codes from a specific fare of a flight\ \ to be added to the booking if `ApplyServiceBundle`\nis set to `Yes`\ \ or `Copy`.\n " nullable: true items: type: string applyServiceBundle: description: "Determines whether to sell bundles in the booking. Can also\ \ be used for cancel or rebook situations.\n " nullable: true $ref: '#/components/schemas/ApplyServiceBundle' IJsonResponseOfIListOfSeatMapStatelessAvailability: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/SeatMapStatelessAvailability' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfLowFareAvailabilityv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/LowFareAvailabilityv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' LowFareAvailabilityv2: type: object description: "Low fare availability contains all information returned when requesting\ \ a low fare trip availability.\n " additionalProperties: false properties: trips: type: array description: "The collection of low fare trips based on market.\n \ \ " nullable: true items: $ref: '#/components/schemas/LowFareTripMarket' includeTaxesAndFees: type: boolean description: "Flag indicating if the trips include taxes and fees.\n \ \ " currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 1 nullable: true LowFareTripMarket: type: object description: "The low fare trip market represents a collection of markets.\n\ \ " additionalProperties: false properties: lowFareAvailableByMarket: type: object description: "The dictionary of available journeys per market.\n \ \ " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/LowFareDateMarket' LowFareDateMarket: type: object description: "Low fare availability contains all information returned when requesting\ \ a low fare trip availability.\n " additionalProperties: false properties: lowestFareAmount: description: "The lowest passenger fare amount for the date market.\n \ \ " nullable: true $ref: '#/components/schemas/LowFareAmount' lowFares: type: array description: "The low fare information for a specific flight.\n \ \ " nullable: true items: $ref: '#/components/schemas/LowFare' destination: type: string description: "The destination station code.\n " maxLength: 3 minLength: 3 nullable: true origin: type: string description: "The origin station code.\n " maxLength: 3 minLength: 3 nullable: true departureDate: type: string description: "The departure date. This is the date only.\n " format: date-time noFlights: type: boolean description: "Flag indicating that there are no flights for this day.\n\ \ " LowFareAmount: type: object description: "Low fare passengers contains the passenger type specific data.\n\ \ " additionalProperties: false properties: fareAmount: type: number description: "Fare Amount for Passenger Type.\n " format: decimal farePointAmount: type: number description: "Fare Point Amount.\n " format: decimal taxesAndFeesAmount: type: number description: "Taxes and Fees Amount.\n " format: decimal LowFare: type: object description: "Low fare contains the information for a specific flight.\n \ \ " additionalProperties: false properties: passengers: type: object description: "Low fare passenger collection with they key of passenger type.\n\ \ " nullable: true additionalProperties: $ref: '#/components/schemas/LowFarePassenger' bookingClasses: type: array description: "Booking classes available.\n " nullable: true items: type: string arrivalTime: type: string description: "The arrival date and time.\n " format: date-time departureTime: type: string description: "The departure date and time.\n " format: date-time legs: type: array description: "Leg information.\n " nullable: true items: $ref: '#/components/schemas/LowFareLeg' availableCount: type: integer description: "Available count for the fare.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 productClass: type: string description: "The product class for the fare.\n " nullable: true referenceFareKey: type: string description: "The reference fare sell key.\n " nullable: true soldOut: type: boolean description: "Flag indicating that the flights are sold out.\n \ \ " LowFarePassenger: type: object description: "Low fare passengers contains the passenger type specific data.\n\ \ " additionalProperties: false properties: fareAmount: type: number description: "Fare Amount for Passenger Type.\n " format: decimal farePointAmount: type: number description: "Fare Point Amount.\n " format: decimal taxesAndFeesAmount: type: number description: "Taxes and Fees Amount.\n " format: decimal discountCode: type: string description: "Passenger Discount Code.\n " nullable: true type: type: string description: "Passenger Type.\n " nullable: true LowFareLeg: type: object description: "Low fare leg information.\n " additionalProperties: false properties: arrivalTime: type: string description: "The arrival date and time.\n " format: date-time departureTime: type: string description: "The departure date and time.\n " format: date-time destination: type: string description: "The destination station code.\n " maxLength: 3 minLength: 3 nullable: true origin: type: string description: "The origin station code.\n " maxLength: 3 minLength: 3 nullable: true flightNumber: type: string description: "Gets or sets the flight number.\n " nullable: true carrierCode: type: string description: "Gets or sets the carrier code.\n " maxLength: 3 minLength: 2 nullable: true equipmentType: type: string description: "The leg type of the equipment.\n " maxLength: 3 minLength: 0 nullable: true operatingCarrier: type: string description: "The operating carrier code.\n " nullable: true LowFareAvailabilitySearchSimpleRequest: type: object description: "Model representing a low fare availability search simple request.\n\ \ " additionalProperties: false required: - origin - destination - beginDate - passengers properties: origin: type: string description: "The origin station code.\n " maxLength: 3 minLength: 3 destination: type: string description: "The destination station code.\n " maxLength: 3 minLength: 3 beginDate: type: string description: "The departure date. This date represents the selected day\ \ by the user, the date range will be calculated from this\ndate as the\ \ starting date.\n " format: date-time minLength: 1 endDate: type: string description: "The return date. This date represents the returning trips\ \ selected day by the user, the date range will be\ncalculated from this\ \ date and the starting date.\n " format: date-time nullable: true passengers: type: array description: "The list of passenger search criteria.\n " items: $ref: '#/components/schemas/PassengerSearchCriteria' promotionCode: type: string description: "The promo code to be applied.\n " maxLength: 8 minLength: 0 nullable: true currencyCode: type: string description: "The search currency code.\n " maxLength: 3 minLength: 0 nullable: true loyaltyFilter: description: "The loyalty fare filter.\n " nullable: true $ref: '#/components/schemas/LoyaltyFilter' daysToLeft: type: integer description: "The number of days to subtract from the begin/end date.\n\ \ " format: int32 nullable: true daysToRight: type: integer description: "The number of days to add to the begin/end date.\n \ \ " format: int32 nullable: true LowFareAvailabilityRequest: type: object description: "Defines the low are availability request.\n " additionalProperties: false required: - passengers - criteria properties: bypassCache: type: boolean description: "Flag indicating to bypass the low fare cache and use real\ \ time results instead of cached results.\n " nullable: true getAllDetails: type: boolean description: "Flag indicating to return all data used for low fare caching,\ \ this is used for external caching providers.\n " nullable: true includeTaxesAndFees: type: boolean description: "Flag indicating to include taxes and fees on the response.\n\ \ " nullable: true passengers: description: "The passenger type criteria.\nIf caching is on this field\ \ will not be honored, and will use the previously cached PassengerTypes.\n\ \ " $ref: '#/components/schemas/PassengerTypeCriteria' codes: description: "The low fare code criteria.\n " nullable: true $ref: '#/components/schemas/LowFareAvailabilityCodeCriteria' filters: description: "The low fare filtering criteria.\n " nullable: true $ref: '#/components/schemas/LowFareAvailabilityFilterCriteria' criteria: type: array description: "The list of low fare availability search criteria.\n \ \ " items: $ref: '#/components/schemas/LowFareAvailabilityCriteria' LowFareAvailabilityCodeCriteria: type: object description: "Describes the low fare availability code criteria.\n \ \ " additionalProperties: false properties: currency: type: string description: "The currency code is which to return the results.\n \ \ " maxLength: 3 minLength: 0 nullable: true sourceOrganization: type: string description: "The specified organization code (aka travel agencies) to allow\ \ for discounts or private fares.\n " maxLength: 10 minLength: 0 nullable: true promotionCode: type: string description: "The promotion code to be applied.\n " maxLength: 8 minLength: 0 nullable: true LowFareAvailabilityFilterCriteria: type: object description: "Describes the low fare availability filtering criteria.\n \ \ " additionalProperties: false properties: groupByDate: type: boolean description: "Flag indicating to return only one low fare per date when\ \ multiple markets are requested.\n " nullable: true flightFilter: description: "Controls the flights that are included in a low fare availability\ \ response.\n " nullable: true $ref: '#/components/schemas/LowFareFlightFilter' loyalty: description: "Filters fares based on loyalty.\n " nullable: true $ref: '#/components/schemas/LoyaltyFilter' bookingClasses: type: array description: "The list of booking classes to filter the results by.\n \ \ " nullable: true items: type: string productClasses: type: array description: "The list of product classes to filter the results by.\n \ \ " nullable: true items: type: string fareTypes: type: array description: "The list of fare types to filter the results by.\n \ \ " nullable: true items: type: string LowFareFlightFilter: type: integer description: "Filter used to filter the types of availability to be returned\ \ for low fare.\n \n\n0 = NoFlights\n1 = AllFlights\n2 = SelectedFlight" x-enumNames: - NoFlights - AllFlights - SelectedFlight enum: - 0 - 1 - 2 LowFareAvailabilityCriteria: type: object description: "Defines the low fare availability search criteria.\n \ \ " additionalProperties: false required: - destinationStationCodes - originStationCodes - beginDate properties: destinationStationCodes: type: array description: "The Arrival Station Codes.\n " items: type: string originStationCodes: type: array description: "The Departure Station Codes.\n " items: type: string beginDate: type: string description: "The Begin Date.\n " format: date-time minLength: 1 endDate: type: string description: "The End Date.\n " format: date-time nullable: true PassengerAddressEditRequestv2: type: object description: "Defines a passenger address edit request v2.\n " additionalProperties: false properties: lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true companyName: type: string description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 nullable: true phone: type: string description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 nullable: true emailAddress: type: string description: "The email address associated with the address.\n \ \ " nullable: true cultureCode: type: string description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 nullable: true refusedContact: type: boolean description: "Indicates if the passenger refused to enter a contact.\n \ \ " nullable: true DeltaMapperOfPassengerAddressEditRequestv2: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true companyName: type: string description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 nullable: true phone: type: string description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 nullable: true emailAddress: type: string description: "The email address associated with the address.\n \ \ " nullable: true cultureCode: type: string description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 nullable: true refusedContact: type: boolean description: "Indicates if the passenger refused to enter a contact.\n \ \ " nullable: true IJsonResponseOfBoardingPassesCollectionv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BoardingPassesCollectionv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BoardingPassesCollectionv2: type: object description: "Defines the boarding passes base that contains all the common\ \ boarding pass details that is not specific to bar\ncode type.\n \ \ " additionalProperties: false properties: recordLocator: type: string description: "The record locator in reference.\n " nullable: true currencyCode: type: string description: "The currency code.\n " nullable: true contactPhoneNumber: type: string description: "The booking contacts phone number.\n " nullable: true boardingPasses: type: array description: "The collection of boarding passes.\n " nullable: true items: $ref: '#/components/schemas/BoardingPassv2' BoardingPassv2: type: object description: "Defines the top level boarding pass details.\n " additionalProperties: false properties: userName: type: string description: "The user name of the logged in user.\n " nullable: true iataCode: type: string description: "The IATA code.\n " nullable: true fareBasisCode: type: string description: "The acting fare basis code.\n " nullable: true fareClass: type: string description: "The acting fare class.\n " nullable: true baseFare: type: number description: "The base fare amount.\n " format: decimal totalFare: type: number description: "The total fare amount.\n " format: decimal totalCost: type: number description: "The total cost amount.\n " format: decimal discountedFare: type: number description: "The discounted fare amount.\n " format: decimal totalTax: type: number description: "The total amount of tax.\n " format: decimal receiptNumber: type: string description: "The receipt number.\n " nullable: true serviceCharges: type: array description: "The collection of service charges for this segment.\n \ \ " nullable: true items: $ref: '#/components/schemas/ServiceCharge' passenger: description: "The passenger details.\n " nullable: true $ref: '#/components/schemas/BoardingPassPassengerDetailsv2' segments: type: array description: "The collection of segments for the barcode.\nNote these can\ \ represent leg information on a change of gauge flight.\n " nullable: true items: $ref: '#/components/schemas/BoardingPassSegment' BoardingPassPassengerDetailsv2: type: object description: "Defines the boarding pass passenger details.\n " additionalProperties: false properties: type: type: string description: "The passenger type.\n " nullable: true selecteeString: type: string description: "The string that indicates a selectee.\n " nullable: true customerNumber: type: string description: "The customer number.\n " nullable: true score: description: "The passenger score.\n " nullable: true $ref: '#/components/schemas/BoardingPassPassengerScore' infant: description: "The passengers infant details if an infant exists.\n \ \ " nullable: true $ref: '#/components/schemas/BoardingPassInfantDetails' name: description: "The given name.\n " nullable: true $ref: '#/components/schemas/Name' isoName: description: "The given name converted to ISO standard.\n " nullable: true $ref: '#/components/schemas/Name' dateOfBirth: type: string description: "The date of birth.\n " format: date-time nullable: true gender: description: "The gender.\n " $ref: '#/components/schemas/Gender' documents: type: array description: "The collection of travel documents.\n " nullable: true items: $ref: '#/components/schemas/PassengerTravelDocument' barCode: type: string description: "The passenger bar code.\n " nullable: true BoardingPassFilterRequest: type: object description: "Defines the boarding pass request that is responsible for filtering\ \ the boarding pass response.\n " additionalProperties: false properties: passengerKeys: type: array description: "The selected passenger keys to be returned. If null all passengers\ \ will be returned that have been checked in.\n " nullable: true items: type: string source: type: string description: "Name of the application requesting for boarding pass print.\n\ Please note that this should be a char and not a string.\nValid values\ \ are 'O', 'K', 'M', 'W', and ' '.\n " maxLength: 1 nullable: true skipLogToHistory: type: boolean description: "Whether to add event to history log.\n " segmentKeys: type: array description: "The selected segment keys to be returned. If null all segments\ \ will be returned that have been checked into.\n " nullable: true items: type: string IJsonResponseOfSsrAvailability: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SsrAvailability' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SsrAvailability: type: object description: "Model containing all Ssr information.\n " additionalProperties: false properties: segmentSsrs: type: array description: "Segment SSRs.\n " nullable: true items: $ref: '#/components/schemas/SsrBySegment' legSsrs: type: array description: "Leg SSRs.\n " nullable: true items: $ref: '#/components/schemas/SsrByLeg' journeySsrs: type: array description: "Journey Ssrs.\n " nullable: true items: $ref: '#/components/schemas/SsrByJourney' SsrBySegment: type: object description: "Model information for a special service request (SSR) tied to\ \ a specific segment.\n " additionalProperties: false properties: segmentKey: type: string description: "The unique identifier of the segment of a journey.\n \ \ " nullable: true segmentDetails: description: "Segment market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' ssrs: type: array description: "The associated SSRs.\n " nullable: true items: $ref: '#/components/schemas/SsrDetail' SsrDetail: type: object description: "Provides more information about the special service request (SSR).\n\ \ " additionalProperties: false properties: ssrCode: type: string description: "The unique code for the SSR.\n " nullable: true passengersAvailability: type: object description: "The passengers to which this SSR is available.\n \ \ " nullable: true additionalProperties: $ref: '#/components/schemas/PassengerSsrAvailability' ssrType: description: "Indicates the type of SSR.\n " $ref: '#/components/schemas/SsrType' name: type: string description: "Short description or name of the SSR.\n " nullable: true limitPerPassenger: type: integer description: "Indicates how many SSRs is allowed per passenger.\n \ \ " format: int32 available: type: integer description: "The number of SSRs available.\n " format: int32 nullable: true inventoryControlled: type: boolean description: "Indicates if the SSR is inventory controlled.\n \ \ " seatDependent: type: boolean description: "Indicates if the SSR is seat-dependent.\n " feeCode: type: string description: "The fee code associated with the SSR.\n " nullable: true nest: type: string description: "The SSR nest.\n " nullable: true seatRestriction: description: "Indicates the seat restriction for the SSR.\n " $ref: '#/components/schemas/SeatRestriction' SsrByLeg: type: object description: "Model information for a special service request (SSR) tied to\ \ a specific leg.\n " additionalProperties: false properties: legKey: type: string description: "The unique identifier of the leg of a segment.\n \ \ " nullable: true legDetails: description: "Leg market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' ssrs: type: array description: "The associated SSRs.\n " nullable: true items: $ref: '#/components/schemas/SsrDetail' SsrByJourney: type: object description: "Model information for a special service request (SSR) tied to\ \ a specific journey.\n " additionalProperties: false properties: journeyKey: type: string description: "The unique identifier of the journey.\n " nullable: true journeyDetails: description: "Journey market information.\n " nullable: true $ref: '#/components/schemas/MarketInformation' ssrs: type: array description: "The associated SSRs.\n " nullable: true items: $ref: '#/components/schemas/SsrDetail' SsrAvailabilityRequestv3: type: object description: "Represents a Special Service Request (SSR) availability request,\ \ version 3.\n " additionalProperties: false required: - trips - passengerKeys - currencyCode properties: trips: type: array description: "The list of trips for which SSR availability is requested.\ \ If not specified, availability for all the non-passive\nsegments in\ \ the booking will be returned.\n " maxItems: 100 items: $ref: '#/components/schemas/MarketInformation' passengerKeys: type: array description: "The list of passengers in which the SSRs are available for.\ \ If not specified, availability for all passengers in\nthe booking will\ \ be returned.\n " maxItems: 100 items: type: string currencyCode: type: string description: "Sets the currency code if different from the booking currency\ \ code.\n " maxLength: 3 minLength: 0 feePricingMode: description: "Indicates whether a fee is meant to be sold in points or currency.\n\ \ " nullable: true $ref: '#/components/schemas/FeePricingMode' ssrAvailabilityMode: description: "Indicates if the availability is for bundled or non-bundled\ \ SSRs.\n " nullable: true $ref: '#/components/schemas/SsrAvailabilityMode' SsrAvailabilityMode: type: integer description: "SSR availability modes for use in the SSR availability request.\n\ \ \n\n0 = NonBundledSsrs\n1 = BundledSsrs\n2 = FilteredBundleSsrs" x-enumNames: - NonBundledSsrs - BundledSsrs - FilteredBundleSsrs enum: - 0 - 1 - 2 SingleSsrByKeyRequestv2: type: object description: "The single ssr by key request model, v2.\n " additionalProperties: false properties: count: type: integer description: "The number of items to include. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true note: type: string description: "Notes associated with this Ssr.\n " nullable: true forceWaveOnSell: type: boolean description: "Force wave on sell. Default value is false.\n " nullable: true currencyCode: type: string description: "Set the Currency Code if different than the booking currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true feePricingMode: description: "Indicates whether the SSR is meant to be sold in points or\ \ in currency.\n " nullable: true $ref: '#/components/schemas/FeePricingMode' ssrSellMode: description: "Indicates whether the SSR is meant to be sold in the passenger's\ \ service bundle.\n " $ref: '#/components/schemas/SsrSellMode' SsrSellMode: type: integer description: "The ssr sell mode enumeration.\n \n\n0 = NonBundle\n\ 1 = Bundle\n2 = BundleSsrSwap" x-enumNames: - NonBundle - Bundle - BundleSsrSwap enum: - 0 - 1 - 2 IJsonResponseOfAvailabilityWithSsrResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AvailabilityWithSsrResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AvailabilityWithSsrResponse: type: object description: "Defines the trip availability with SSR response.\n " additionalProperties: false properties: results: type: array description: "The collection of trip results based on date and markets.\n\ \ " nullable: true items: $ref: '#/components/schemas/TripResult' faresAvailable: type: object description: "The aggregate collection of fares available for all the provided\ \ journeys.\n " nullable: true additionalProperties: $ref: '#/components/schemas/FareReference' currencyCode: type: string description: "The currency code for all displayed fares.\n " maxLength: 17 minLength: 0 nullable: true includeTaxesAndFees: type: boolean description: "Flag indicating if the trip includes taxes and fees.\n \ \ " bundleOffers: type: object description: "The collection of service bundle offers available for all\ \ the provided journeys, if requested.\n " nullable: true additionalProperties: $ref: '#/components/schemas/BundleOffer' includedSsrs: type: array description: "Prices of the SSRs included in the request.\n " nullable: true items: $ref: '#/components/schemas/AvailabilityWithSsrPrice' AvailabilityWithSsrPrice: type: object description: "This class contains an SSR and its possible prices with respect\ \ to each journey in the availability. Primarily used\nin GetTripAvailabilityWithSSR.\n\ \ " additionalProperties: false properties: ssrCode: type: string description: "The code of the SSR being priced.\n " nullable: true priceVariations: type: array description: "A list of possible price variants of the SSR when priced against\ \ each journey in the availability.\n " nullable: true items: $ref: '#/components/schemas/SsrPriceVariation' reference: type: string description: "The reference to the fare from the available journey fare\ \ details.\n " nullable: true SsrPriceVariation: type: object description: "This class denotes a possible pricing of an SSR against the journeys\ \ of the availability. Primarily used in\nGetTripAvailabilityWithSSR.\n \ \ " additionalProperties: false properties: basePrice: type: number description: "The base price of the applied fee.\n " format: decimal nullable: true taxTotal: type: number description: "The applied sales tax.\n " format: decimal nullable: true passengerType: type: string description: "The applying passenger type.\n " nullable: true programLevel: type: string description: "The applying customer program level.\n " nullable: true AvailabilityWithSsrRequest: type: object description: "Defines the request to retrieve trip availability with SSR.\n\ \ " additionalProperties: false required: - passengers - criteria properties: passengers: description: "The list of passengers.\n " $ref: '#/components/schemas/PassengerTypeCriteria' criteria: type: array description: "The list of availability search criteria.\n " items: $ref: '#/components/schemas/AvailabilityCriteria' codes: description: "The different code criteria that can be set that can influence\ \ availability response.\n " nullable: true $ref: '#/components/schemas/AvailabilityCodeCriteriav2' taxesAndFees: description: "The taxes and fees rollup mode which affects the pricing information.\n\ \ " nullable: true $ref: '#/components/schemas/TaxesAndFeesRollupMode' numberOfFaresPerJourney: type: integer description: "The number of fares per journey to be returned. If not set\ \ it will use the default optimized values\n " format: int32 nullable: true returnEmptyResults: type: boolean description: "Flag determining if empty schedule responses will be returned.\n\ Defaults to false.\n " nullable: true passengerCountOverride: type: integer description: "An optional parameter to control the total passenger count\ \ passed to NewSkies.\nIf this is not provided, the API will add up the\ \ individual passenger information\ndata provided on the passenger type\ \ criteria portion of the request.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 nullable: true ssrs: type: array description: "SSRs to be priced in the availability.\n " nullable: true items: type: string feePricingMode: description: "Indicates whether a fee is meant to be sold in points or currency.\n\ \ " $ref: '#/components/schemas/FeePricingMode' programCode: type: string description: "The applying customer program code.\n " nullable: true programLevel: type: string description: "The applying customer program level.\n " nullable: true DivideRequestv2: type: object description: "Defines the booking divide request.\n " additionalProperties: false properties: crsRecordLocators: type: array description: "The CRS record locators.\nIf a record locator and/or owning\ \ system code is provided they will be used instead of the record locator\ \ key\nvalues.\n " nullable: true items: $ref: '#/components/schemas/RecordLocator' passengerKeys: type: array description: "The passengers to include specified by their respective keys.\n\ \ " nullable: true items: type: string autoDividePayments: type: boolean description: "Allow the divide to automatically divide payments between\ \ bookings.\n " bookingPaymentTransfers: type: array description: "Specific amounts to split between the bookings. This is applied\ \ if auto divide payments is set to false.\n " nullable: true items: $ref: '#/components/schemas/BookingPaymentTransfer' receivedBy: type: string description: "Specify the user requesting the booking divide.\n \ \ " maxLength: 64 minLength: 0 nullable: true overrideRestrictions: type: boolean description: "Override any restrictions that may prevent divide.\n \ \ " parentEmail: type: string description: "The email address for updating the parent booking.\n \ \ " nullable: true childEmail: type: string description: "The email address for the child booking.\n " nullable: true cancelSourceBooking: type: boolean description: "Cancel the created booking after divide. If this is set to\ \ true the cancelled booking\nis not returned and its PNR is not easily\ \ available.\n " BookingPaymentTransfer: type: object description: "Defines a booking payment transfer transaction\n " additionalProperties: false properties: bookingPaymentId: type: integer description: "The booking payment id to transfer.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 transferAmount: type: number description: "The amount to include in the transfer\n " format: decimal PassengerAddressCreateRequest: type: object description: "Defines a passenger address create request.\n " additionalProperties: false properties: companyName: type: string description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 nullable: true phone: type: string description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 nullable: true stationCode: type: string description: "Station code associated with this address.\n " maxLength: 3 minLength: 3 nullable: true emailAddress: type: string description: "The email address associated with the address.\n \ \ " nullable: true cultureCode: type: string description: "The culture code for the passenger address.\n " maxLength: 17 minLength: 0 nullable: true refusedContact: type: boolean description: "Indicates if the passenger refused to enter a contact.\n \ \ " nullable: true lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true status: description: "The addresses APIS status.\n " $ref: '#/components/schemas/ApisAddressStatus' DeltaMapperOfInfant: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: dateOfBirth: type: string description: "The date of birth of the infant.\n " format: date-time nullable: true gender: description: "The gender of the passenger.\n " nullable: true $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " nullable: true properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true declaredGender: type: string description: "The infant's declared gender. A value of \"F\" is mapped to\ \ a female binary gender. All other values will be\nmapped to a male binary\ \ gender.\n " maxLength: 2 minLength: 0 nullable: true nationality: type: string description: "The nationality of the passenger.\n " maxLength: 2 minLength: 0 nullable: true residentCountry: type: string description: "The residentCountry of the passenger.\n " maxLength: 2 minLength: 0 nullable: true CustomerCreditRefundRequest: type: object description: "Defines information needed for a customer credit refund.\n \ \ " additionalProperties: false required: - parentPaymentKey - amount - customerNumber properties: parentPaymentKey: type: string description: "The payment identifier used if this refund is being reversed\ \ from an existing payment.\n " minLength: 1 amount: type: number description: "The amount to apply.\n " format: decimal paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true customerNumber: type: string description: "The customer account number to credit to.\n " maxLength: 34 minLength: 0 accountTransactionCode: type: string description: "The account transaction code associated with the account.\n\ \ " nullable: true comment: type: string description: "The customer credit refund comment.\n " nullable: true IJsonResponseOfETicketResponsev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ETicketResponsev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ETicketResponsev2: type: object description: "The response for retrieving and displaying e-ticket information.\n\ \ " additionalProperties: false properties: eTicket: description: "The e-ticket which is equivalent to the New Skies passenger\ \ ticket.\n " nullable: true $ref: '#/components/schemas/PassengerTicketv2' status: description: "The status return code when retrieving e-tickets.\n \ \ " $ref: '#/components/schemas/TicketReturnCode' alternateCarrierCode: type: string description: "The alternate carrier code. This is also known as the e-ticket\ \ database, or the carrier code of the issuing\nairline.\n " nullable: true PassengerTicketv2: type: object description: "Represents detailed information for an e-ticket issued to a passenger.\n\ \ " additionalProperties: false properties: passengerName: description: "The passenger name.\n " nullable: true $ref: '#/components/schemas/Name' connectedETickets: type: array description: "The list of e-tickets issued to the passenger.\n \ \ " nullable: true items: $ref: '#/components/schemas/ETicket' exchangedETickets: type: array description: "The previous e-tickets when e-tickets were reissue for the\ \ booking.\n " nullable: true items: $ref: '#/components/schemas/ETicket' recordLocators: type: array description: "Record locators associated with the e-ticket.\n \ \ " nullable: true items: $ref: '#/components/schemas/RecordLocator' fareCalculation: type: string description: "The fare calculation. This property is redundant and the same\ \ information can be found on the Remarks property.\n " deprecated: true x-deprecatedMessage: 4.4.4 - Please use Remarks instead. nullable: true issueDate: type: string description: "The date the e-ticket was issued.\n " format: date-time nullable: true companyIdNumber: type: string description: "The company ID number of the service airline or system service\ \ provider.\n " nullable: true chargeCode: type: string description: "The non-numeric value for the e-ticket's total fare value.\n\ \ " nullable: true totalTaxAmount: type: number description: "The tax amount for the e-ticket.\n " format: decimal taxDetailsList: type: array description: "The list of all tax details of the e-ticket.\n " nullable: true items: $ref: '#/components/schemas/TaxDetails' ticketFare: description: "The base fare represented in the e-ticket's currency code\ \ and foreign currency code.\n " nullable: true $ref: '#/components/schemas/PassengerTicketFare' totalAmount: type: number description: "The total amount for the e-ticket.\n " format: decimal totalAmountCurrencyCode: type: string description: "The currency code of the total amount for the e-ticket.\n\ \ " nullable: true remarks: type: array description: "Additional information associated to the e-ticket.\n \ \ " nullable: true items: $ref: '#/components/schemas/Remark' createdUserIdentifier: type: string description: "The created user's identifier.\n " nullable: true ETicket: type: object description: "The base e-ticket model.\n " additionalProperties: false properties: couponCount: type: integer description: "The number of coupons contained in the e-ticket.\n \ \ " format: int32 ticketNumber: type: string description: "The e-ticket number.\n " nullable: true ticketEmds: type: array description: "The associated EMDs to the e-ticket.\n " nullable: true items: type: string TaxDetails: type: object description: "The tax details for an e-ticket.\n " additionalProperties: false properties: taxCode: type: string description: "The tax code.\n " nullable: true amount: type: number description: "The tax amount.\n " format: decimal currencyCode: type: string description: "The currency code of the tax amount.\n " nullable: true PassengerTicketFare: type: object description: "Represents fare information for an e-ticket issued to a passenger.\n\ \ " additionalProperties: false properties: baseAmount: type: number description: "The base fare amount of the e-ticket.\n " format: decimal currencyCode: type: string description: "The base fare amount's currency code.\n " nullable: true foreignAmount: type: number description: "The base fare (excluding taxes, fees, and charges) in the\ \ collected currency.\n " format: decimal foreignCurrencyCode: type: string description: "The foreign amount's currency code.\n " nullable: true Remark: type: object description: "The fare calculation line associated to an e-ticket.\n \ \ " additionalProperties: false properties: textQualifier: description: "The text qualifier.\n " $ref: '#/components/schemas/TextSubjectQualifier' informationType: description: "The information type.\n " $ref: '#/components/schemas/InformationType' freeTexts: type: array description: "The text pulled from the matching remark's list of free texts\ \ for the fare calculation.\nTypically the text needed is stored as the\ \ first value in the list.\n " nullable: true items: type: string TextSubjectQualifier: type: integer description: "Defines the text subject qualifier of remarks in an e-ticket.\n\ \ \n\n0 = Unknown\n1 = CodedFreeText\n2 = LiteralText\n3 = CodedAndLiteralText\n\ 4 = ChangeInformation\n5 = ProductInformation\n6 = SafetyInformation\n7 =\ \ IataDefinedInformation\n8 = SpecialHandling\n9 = StatutoryNotice\n10 = TransportationInformation\n\ 11 = MutuallyDefined" x-enumNames: - Unknown - CodedFreeText - LiteralText - CodedAndLiteralText - ChangeInformation - ProductInformation - SafetyInformation - IataDefinedInformation - SpecialHandling - StatutoryNotice - TransportationInformation - MutuallyDefined enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 InformationType: type: integer description: "Defines the information type of the remarks in an e-ticket.\n\ \ \n\n0 = Unknown\n1 = FlifoExists\n2 = Address\n3 = BusinessTelephoneNumber\n\ 4 = HomeTelephoneNumber\n5 = TelephoneNatureUnknown\n6 = TravelAgentTelephoneNumber\n\ 7 = Remarks\n8 = ReferenceIndication\n9 = TicketNumber\n10 = EndorsementInformation\n\ 11 = CommissionInformation\n12 = FareCalculationOnTicketing\n13 = IssuingNameAndPlace\n\ 14 = OriginalIssueInformation\n15 = IssueReasonSubCodeDescription" x-enumNames: - Unknown - FlifoExists - Address - BusinessTelephoneNumber - HomeTelephoneNumber - TelephoneNatureUnknown - TravelAgentTelephoneNumber - Remarks - ReferenceIndication - TicketNumber - EndorsementInformation - CommissionInformation - FareCalculationOnTicketing - IssuingNameAndPlace - OriginalIssueInformation - IssueReasonSubCodeDescription enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 TicketReturnCode: type: integer description: "Defines the status or outcome of an e-ticket operation.\n \ \ \n\n0 = Unknown\n1 = Success\n2 = TicketNotFound\n3 = NotAuthorized\n\ 4 = IssueRetrievingTicket\n5 = NoETicketConfiguration" x-enumNames: - Unknown - Success - TicketNotFound - NotAuthorized - IssueRetrievingTicket - NoETicketConfiguration enum: - 0 - 1 - 2 - 3 - 4 - 5 IJsonResponseOfUpdateETicketCouponResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/UpdateETicketCouponResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' UpdateETicketCouponResponse: type: object description: "Represents a response from updating coupons from within an e-ticket.\n\ \ " additionalProperties: false properties: status: description: "The status return code upon updating an e-ticket coupon.\n\ \ " $ref: '#/components/schemas/TicketReturnCode' errorText: type: string description: "The error text from the e-ticket database, if the update resulted\ \ in an error.\n " nullable: true tickets: type: array description: "Indicates the detailed e-ticket information from the coupon\ \ update results.\n " nullable: true items: $ref: '#/components/schemas/PassengerTicketInfo' UpdateETicketCouponRequestBase: type: object description: "Represents a request for updating coupons from within an e-ticket.\n\ \ " additionalProperties: false properties: hostedCarrierCode: type: string description: "The hosted carrier code. If not provided, the hosted carrier\ \ code will be retrieved internally.\n " nullable: true alternateCarrierCode: type: string description: "The alternate carrier code. This is required if the ticket\ \ is issued by another airline.\n " nullable: true oaValidatingCarrier: type: string description: "Validating carrier code.\n " maxLength: 3 minLength: 2 nullable: true comment: type: string description: "Comment text.\n " nullable: true isVoluntaryChange: type: boolean description: "Indicates a voluntary change to the coupon or otherwise.\n\ \ " updateFunction: description: "Indicates the type of update function to be done in the coupon.\n\ \ " $ref: '#/components/schemas/ETicketCouponUpdateFunction' status: description: "Indicates the new status for the coupon.\n " $ref: '#/components/schemas/ETicketCouponStatusCode' ETicketCouponUpdateFunction: type: integer description: "Represents the function types used to update an e-ticket coupon.\n\ \ \n\n0 = UpdateCouponStatus\n1 = ManualCouponStatusChange\n2 =\ \ RequestReturnControl\n3 = RequestAirportControl" x-enumNames: - UpdateCouponStatus - ManualCouponStatusChange - RequestReturnControl - RequestAirportControl enum: - 0 - 1 - 2 - 3 Category50Requestv2: type: object description: "Represents a v2 cat 50 request.\n " additionalProperties: false required: - fareAvailabilityKey - passengerPriceTypes properties: fareAvailabilityKey: type: string description: "The fare availability key.\n " minLength: 1 passengerPriceTypes: type: array description: "The list of passenger types and the counts for each.\n \ \ " items: $ref: '#/components/schemas/PassengerPriceType' cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 nullable: true convertToHtml: type: boolean description: "Flag, if true, convert response to html. Defaults to true.\n\ \ " nullable: true PassengerPriceType: type: object description: "Represents a cat 50 request.\n " additionalProperties: false properties: passengerType: type: string description: "The passenger type code assigned to this group of passengers.\n\ \ " maxLength: 4 minLength: 0 nullable: true passengerDiscountCode: type: string description: "The passenger discount code assigned to this group of passengers.\n\ This value will be overriden if there is a passenger\ndiscount code associated\ \ with the availability requests promotion code.\n " maxLength: 4 minLength: 0 nullable: true passengerCount: type: integer description: "The number of passengers in this group with the specified\ \ passenger type\nand discount code.\n " format: int32 IJsonResponseOfIListOfPassengerSeat: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerSeat' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPassengerSeat: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerSeat' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AddSeatRequest: type: object description: "Defines update seat request.\n " additionalProperties: false properties: collectedCurrencyCode: type: string description: "Optional Currency code if different than booking currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true inventoryControl: description: "Indicates the type of hold placed on a unit.\n " nullable: true $ref: '#/components/schemas/UnitInventoryControlType' seatAssignmentMode: description: "The seat assignment mode.\n " nullable: true $ref: '#/components/schemas/SeatAssignmentMode' feePricingMode: description: "Indicates if the seat is to be sold in currency or points.\n\ \ " nullable: true $ref: '#/components/schemas/FeePricingMode' waiveFee: type: boolean description: "The flag indicating to waive the seat fees if permissions\ \ permit.\n " nullable: true ignoreSeatSsrs: type: boolean description: "Flag indicating whether to ignore seat SSR's.\n \ \ " nullable: true journeyKey: type: string description: "The journey key.\n " nullable: true SsrsRequest: type: object description: "Request to add multiple leg, segment, or journey Ssr's.\n \ \ " additionalProperties: false required: - requests properties: requests: type: array description: "Ssr requests by type of request (Journey, Leg, Segment).\n\ \ " items: $ref: '#/components/schemas/SsrsByType' forceWaveOnSell: type: boolean description: "Force wave on sell. Default value is false.\n " nullable: true currencyCode: type: string description: "Set the currency code if different than the booking currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true feePricingMode: description: "Indicates whether the SSR is meant to be sold in points or\ \ in currency.\n " nullable: true $ref: '#/components/schemas/FeePricingMode' SsrsByType: type: object description: "Ssrs by type model allows multiple Ssr requests for a specific\ \ type.\n " additionalProperties: false required: - type - market - items properties: type: description: "Defines the duration type of the Ssr.\n " $ref: '#/components/schemas/SsrDurationType' market: description: "Market for the corresponding type.\n " $ref: '#/components/schemas/MarketInformation' items: type: array description: "SSR request items.\n " items: $ref: '#/components/schemas/SsrRequest' SsrRequest: type: object description: "SSR request for a single Ssr.\n " additionalProperties: false required: - ssrCode - passengerKey properties: ssrCode: type: string description: "The Ssr code.\n " minLength: 1 count: type: integer description: "The number of items to include. Defaults to 1.\n \ \ " maximum: 32767.0 minimum: 1.0 nullable: true note: type: string description: "Notes associated with this Ssr.\n " nullable: true passengerKey: type: string description: "The passenger key.\n " minLength: 1 inBundle: type: boolean description: "Indicates if the SSR is part of a bundle.\n " SsrAvailabilityRequestv2: type: object description: "Represents an SSR availability request.\n " additionalProperties: false required: - trips - passengerKeys - currencyCode properties: trips: type: array description: "Filter the trips requested.\n " items: $ref: '#/components/schemas/MarketInformation' passengerKeys: type: array description: "Filter the passenger numbers.\n " items: type: string currencyCode: type: string description: "Set the Currency Code if different than the booking currency\ \ code.\n " maxLength: 3 minLength: 0 feePricingMode: description: "Flag to indicate whether a fee is meant to be sold in points\ \ or currency.\n " nullable: true $ref: '#/components/schemas/FeePricingMode' ssrAvailabilityMode: description: "Indicates which types of SSRs in a passenger's service bundle\ \ are to be returned.\n " nullable: true $ref: '#/components/schemas/SsrAvailabilityMode' VoucherConfigurationRequestv2: type: object description: "The voucher configuration request model v2.\n " additionalProperties: false required: - configurationCode - name - description - expirationDate - currencyCode - note properties: configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 name: type: string description: "The voucher configuration name.\n " maxLength: 64 minLength: 0 description: type: string description: "The voucher configuration description.\n " maxLength: 128 minLength: 0 type: description: "The voucher type.\n " nullable: true $ref: '#/components/schemas/VoucherType' issuanceType: description: "The issuance type.\n " nullable: true $ref: '#/components/schemas/IssuanceType' voucherUsageTypes: type: array description: "The voucher usage types.\n " nullable: true items: $ref: '#/components/schemas/VoucherUsageType' tripType: description: "The voucher trip type.\n " $ref: '#/components/schemas/VoucherTripType' expirationControl: description: "The voucher expiration control.\n " $ref: '#/components/schemas/VoucherExpirationControl' expirationType: description: "The voucher expiration type.\n " nullable: true $ref: '#/components/schemas/VoucherExpirationType' expirationDate: type: string description: "The expiration date.\n " format: date-time minLength: 1 expirationDays: type: integer description: "The voucher expiration days.\n " currencyCode: type: string description: "The voucher currency code.\n " maxLength: 3 minLength: 0 amountControl: description: "The voucher amount control.\n " $ref: '#/components/schemas/AmountControl' calculatedAmountControl: description: "The voucher calculated amount control.\n " $ref: '#/components/schemas/CalculatedAmountControl' maximumAmount: type: number description: "The maximum voucher amount.\n " format: decimal maximumPassengers: type: integer description: "The voucher maximum passenger total.\n " maximum: 32767.0 minimum: 1.0 maximumVouchersPerBooking: type: integer description: "The voucher maximum number of vouchers per booking.\n \ \ " travelDayOfWeekRestriction: type: array description: "The voucher day of week travel restrictions.\n " nullable: true items: $ref: '#/components/schemas/DayOfWeek' nameRestriction: description: "The voucher name restriction.\n " $ref: '#/components/schemas/VoucherNameRestriction' voucherRequirements: description: "The voucher requirements.\n " $ref: '#/components/schemas/VoucherRequirements' nextReferenceNumber: type: integer description: "The next reference number for the voucher configuration.\n\ \ " format: int64 note: type: string description: "The voucher configuration note.\n " minLength: 1 maximumAmountIsPerPassenger: type: boolean description: "Flag to indicate if the maximum amount is per passenger or\ \ not.\n " calculatedPercentage: type: number description: "The calculated percentage.\n " format: decimal issuanceControl: description: "The voucher issuance control.\n " $ref: '#/components/schemas/VoucherIssuanceControl' enableVoucherAdjustments: type: boolean description: "Enables voucher adjustments.\n " restrictFlightBatchIssuance: description: "The flight batch issuance restrictions.\n " $ref: '#/components/schemas/RestrictFlightBatchIssuance' voucherUsageBaseFeeType: description: "The voucher usage base fee type.\n " $ref: '#/components/schemas/VoucherUsageBaseFeeType' issueToRevenuePassengersOnly: type: boolean description: "Enables Issuance to revenue passengers only.\n " fareClasses: type: array description: "The voucher configuration fare classes.\n " nullable: true items: $ref: '#/components/schemas/VoucherConfigurationFareClass' marketRestrictions: type: array description: "The voucher configuration market restrictions.\n \ \ " nullable: true items: $ref: '#/components/schemas/VoucherMarketRestriction' travelRestrictions: type: array description: "The voucher configuration travel restrictions.\n \ \ " nullable: true items: $ref: '#/components/schemas/VoucherTravelRestriction' enabled: type: boolean description: "Indicates if the voucher is enabled or disabled.\n \ \ " nullable: true IJsonResponseOfPagedVouchersResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PagedVouchersResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PagedVouchersResponse: type: object description: "The paged voucher search response item.\n " additionalProperties: false properties: lastPageKey: type: string description: "The key for the last item returned from paging.\n \ \ " nullable: true totalCount: type: integer description: "The total count of vouchers that match the search parameters.\n\ This will only be populated if the last page key is not specified.\ni.e.\ \ The initial page of the paged voucher response is being retrieved.\n\ Otherwise, it will be set to 0.\n " format: int32 vouchers: type: array description: "The collection of vouchers.\n " nullable: true items: $ref: '#/components/schemas/VoucherItem' VoucherItem: type: object description: "The voucher item model.\n " additionalProperties: false properties: voucherKey: type: string description: "The voucher key.\n " nullable: true reference: type: string description: "The reference number for the voucher.\n " maxLength: 20 minLength: 0 nullable: true configurationCode: type: string description: "The voucher configuration code.\n " maxLength: 6 minLength: 0 nullable: true status: description: "The voucher status.\n " $ref: '#/components/schemas/VoucherStatus' available: type: number description: "The availability count of the voucher.\n " format: decimal firstName: type: string description: "The first name associated with the voucher.\n " maxLength: 64 minLength: 0 nullable: true lastName: type: string description: "The last name associated with the voucher.\n " maxLength: 64 minLength: 0 nullable: true personKey: type: string description: "The person key associated with the voucher.\n " nullable: true voucherIssuanceKey: type: string description: "The voucher issuance key.\n " nullable: true expiration: type: string description: "The voucher expiration date.\n " format: date-time nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true amount: type: number description: "The amount of currency.\n " format: decimal createdDate: type: string description: "The created date for the voucher item.\n " format: date-time nullable: true FindVoucherSortCriteria: type: integer description: "Defines the criteria in which the find vouchers result can be\ \ sorted. Defaults to `CreatedDateAscending` if not specified or invalid.\n\ \ \n\n0 = CreatedDateAscending\n1 = Name\n2 = CreatedDateDescending" x-enumNames: - CreatedDateAscending - Name - CreatedDateDescending enum: - 0 - 1 - 2 IJsonResponseOfReducedVoucherResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ReducedVoucherResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ReducedVoucherResponse: type: object description: "The reduced voucher response.\n " additionalProperties: false properties: references: type: array description: "The voucher reference numbers.\n " nullable: true items: type: string issuanceKey: type: string description: "The voucher issuance keys.\n " nullable: true IJsonResponseOfLowFareEstimateResults: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/LowFareEstimateResults' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' LowFareEstimateResults: type: object description: "The low fare estimate results model.\n " additionalProperties: false properties: lowFares: type: array description: "The collection of low fare cache availability dates.\n \ \ " nullable: true items: $ref: '#/components/schemas/LowFareEstimateByDate' LowFareEstimateByDate: type: object description: "The low fare availability for a given date.\n " additionalProperties: false properties: date: type: string description: "The date of the low fare.\n " format: date-time price: type: number description: "The low fare price optionally including taxes and fees.\n\ \ " format: decimal taxesAndFees: type: number description: "The taxes and fees which will only be included if asked for\ \ in the request (due to performance). This will be\nincluded in the price\ \ value.\n " format: decimal nullable: true available: type: integer description: "The low fare available count.\n " format: int32 noFlights: type: boolean description: "Flag indicating that there are no flights for this day.\n\ \ " soldOut: type: boolean description: "Flag indicating that the flights are sold out.\n \ \ " referenceFareKeys: type: array description: "Set of Fare Keys that apply to the lowest fare. Corresponds\ \ to the FaresAvailable.Fare.Reference property in the\nAvailability Response.\n\ \ " nullable: true items: type: string IJsonResponseOfAncillaryPricingOptionsContext: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AncillaryPricingOptionsContext' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AncillaryPricingOptionsContext: type: object description: "Defines the ancillary pricing options context.\n " additionalProperties: false properties: samplingRandomNumber: type: number description: "The sampling random number for the ancillary pricing options.\n\ \ " format: double maximum: 1.0 minimum: 0.0 nullable: true inputParameters: type: object description: "The ancillary pricing options input parameters.\n \ \ " nullable: true additionalProperties: type: string IJsonResponseOfIListOfFareBatchResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/FareBatchResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareBatchResponse: type: object description: "The fare batch response model\n " additionalProperties: false properties: fareBatchID: type: integer description: "The fare batch ID\n " format: int32 name: type: string description: "The fare batch name\n " nullable: true implementedDate: type: string description: "The date in UTC the batch is implemented on\n " format: date-time startDate: type: string description: "The batch start date in UTC\n " format: date-time nullable: true endDate: type: string description: "The batch end date in UTC\n " format: date-time nullable: true status: description: "The fare batch status\n " $ref: '#/components/schemas/FareBatchStatus' FareBatchStatus: type: integer description: "Enumeration representing the fare batch statuses.\n \ \ \n\n0 = Default\n1 = Pending\n2 = Processing\n3 = Error\n4 = Complete" x-enumNames: - Default - Pending - Processing - Error - Complete enum: - 0 - 1 - 2 - 3 - 4 IJsonResponseOfFareBatchResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FareBatchResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfFareBatchInitializeResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FareBatchInitializeResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareBatchInitializeResponse: type: object description: "Represents a fare batch initialize response.\n " additionalProperties: false properties: fareBatchId: type: integer description: "The fare batch ID.\n " format: int32 FareBatchInitializeRequest: type: object description: "Represents a fare batch initialize request.\n " additionalProperties: false required: - name properties: name: type: string description: "The name of the fare batch.\n " maxLength: 64 minLength: 0 FareBatchFinalizeRequest: type: object description: "Represents a fare batch finalize request.\n " additionalProperties: false required: - id properties: id: type: integer description: "The fare batch ID.\n " format: int32 finalizeUtc: type: string description: "The UTC time that the batch will be set to pending state.\n\ Note: Can still take time to complete. If not set will default to current\ \ UTC time.\n " format: date-time nullable: true IJsonResponseOfIListOfFareResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/FareResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareResponse: type: object description: "The fare response model\n " additionalProperties: false properties: fareID: type: integer description: "The fare ID.\n " format: int64 fareBatchID: type: integer description: "The fare batch ID.\n " format: int32 fareTariffCode: type: string description: "The fare tariff code.\n " nullable: true ruleNumber: type: string description: "The rule number.\n " nullable: true linkNumber: type: integer description: "The link number.\n " carrierCode: type: string description: "The carrier code.\n " nullable: true classCode: type: string description: "The class code. This will be either a fare basis code or an\ \ allotment basis code.\n " nullable: true isAllotment: type: boolean description: "This determines if the fare is a regular fare or an allotment\ \ fare.\n " location1: type: string description: "The first location code. This must be either a city code or\ \ station code.\n " nullable: true location2: type: string description: "The second location code. This must be either a city code\ \ or station code.\n " nullable: true IJsonResponseOfFareDeepResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FareDeepResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareDeepResponse: type: object description: "The fare deep response model\n " additionalProperties: false properties: fareID: type: integer description: "The fare ID.\n " format: int64 fareBatchID: type: integer description: "The fare batch ID.\n " format: int32 fareTariffCode: type: string description: "The fare tariff code.\n " nullable: true ruleNumber: type: string description: "The rule number.\n " nullable: true linkNumber: type: integer description: "The link number.\n " carrierCode: type: string description: "The carrier code.\n " nullable: true classCode: type: string description: "The class code. This will be either a fare basis code or an\ \ allotment basis code.\n " nullable: true isAllotment: type: boolean description: "This determines if the fare is a regular fare or an allotment\ \ fare.\n " location1: type: string description: "The first location code. This must be either a city code or\ \ station code.\n " nullable: true location2: type: string description: "The second location code. This must be either a city code\ \ or station code.\n " nullable: true fareApplication: type: array description: "The fare application.\n " nullable: true items: $ref: '#/components/schemas/FareApplicationResponse' FareApplicationResponse: type: object description: "The fare application response model\n " additionalProperties: false properties: fareID: type: integer description: "The fare ID.\n " format: int64 fareBatchID: type: integer description: "The fare batch ID.\n " format: int32 currencyCode: type: string description: "The currency code.\n " nullable: true effectiveDate: type: string description: "The effective date.\n " format: date-time discontinueDate: type: string description: "The discontinue date.\n " format: date-time nullable: true fareDirection: description: "The fare direction.\n " $ref: '#/components/schemas/FareDirection' inBoundOutBound: description: "The inbound/outbound specification.\n " $ref: '#/components/schemas/InBoundOutBound' oneWayRoundTrip: description: "The one way/round trip specification.\n " $ref: '#/components/schemas/OneWayRoundTrip' openJaw: type: boolean description: "The boolean indicating if the trip is open jaw.\n \ \ " pointPrice: type: integer description: "The point price.\n " format: int32 price: type: number description: "The price.\n " format: decimal routeNumber: type: integer description: "The Route Number.\n " sortPrice: type: number description: "The sort price.\n " format: decimal nullable: true sumOfSegmentCharge: type: number description: "The sum of segment charge.\n " format: decimal tripDirection: description: "The trip direction.\n " $ref: '#/components/schemas/TripDirection' FareDirection: type: integer description: "Enum representing the fare direction of an object.\n \ \ \n\n0 = Unspecified\n1 = ToOnly\n2 = FromOnly\n3 = BothWays" x-enumNames: - Unspecified - ToOnly - FromOnly - BothWays enum: - 0 - 1 - 2 - 3 InBoundOutBound: type: integer description: "Enum representing the inbound/outbound specification of an object.\n\ \ \n\n0 = Unspecified\n1 = Inbound\n2 = Outbound" x-enumNames: - Unspecified - Inbound - Outbound enum: - 0 - 1 - 2 OneWayRoundTrip: type: integer description: "Enum representing the one way/round trip specification of an object.\n\ \ \n\n0 = Unspecified\n1 = All\n2 = RoundTrip\n3 = OneWayOnly" x-enumNames: - Unspecified - All - RoundTrip - OneWayOnly enum: - 0 - 1 - 2 - 3 TripDirection: type: integer description: "Enum representing the trip direction of an object.\n \ \ \n\n0 = Unspecified\n1 = FromLocationToTravelLocation\n2 = ToLocationFromTravelLocation\n\ 3 = OriginatingAtLocation\n4 = OriginatingAtTravelLocation" x-enumNames: - Unspecified - FromLocationToTravelLocation - ToLocationFromTravelLocation - OriginatingAtLocation - OriginatingAtTravelLocation enum: - 0 - 1 - 2 - 3 - 4 GetFareRequest: type: object description: "The get fare request model\n " additionalProperties: false required: - carrierCode - classCode - isAllotment - ruleNumber - location1 - location2 properties: fareTariffCode: type: string description: "The fare tariff code.\n " nullable: true carrierCode: type: string description: "The carrier code.\n " minLength: 1 classCode: type: string description: "The class code. This will be either a fare basis code or an\ \ allotment basis code.\n " minLength: 1 isAllotment: type: boolean description: "Determines if the fare is a regular fare or an allotment fare.\n\ \ " ruleNumber: type: string description: "The rule number.\n " minLength: 1 linkNumber: type: integer description: "The link number.\n " nullable: true location1: type: string description: "The first location code. This must be either a city code or\ \ station code. These should be placed in alphabetical\norder. If they\ \ are not then directionality will be switched and the locations will\ \ be returned in alphabetical\norder on retrieval.\n " minLength: 1 location2: type: string description: "The second location code. This must be either a city code\ \ or station code. These should be placed in alphabetical\norder. If they\ \ are not then directionality will be switched and the locations will\ \ be returned in alphabetical\norder on retrieval.\n " minLength: 1 IJsonResponseOfIListOfFareTariffResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/FareTariffResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareTariffResponse: type: object description: "The fare tariff response.\n " additionalProperties: false properties: fareTariffCode: type: string description: "The fare tariff code.\n " nullable: true name: type: string description: "The tariff name.\n " nullable: true displayCode: type: string description: "The display code.\n " nullable: true IJsonResponseOfJwtResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/JwtResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' JwtResponse: type: object description: "Represents the JWT response model.\n " additionalProperties: false properties: token: type: string description: "The JWT.\n " nullable: true cultureCode: type: string description: "The culture code set for this token.\n " nullable: true currencyCode: type: string description: "The currency code set for this token.\n " nullable: true roleCode: type: string description: "The role code set for this token.\n " nullable: true locationCode: type: string description: "The location code.\n " nullable: true domainCode: type: string description: "The domain code.\n " nullable: true organizationCode: type: string description: "The organization code.\n " nullable: true expires: type: string description: "The absolute expiration time.\n " format: date-time nullable: true userKey: type: string description: "The user key, if not anonymous.\n " nullable: true personKey: type: string description: "The person key, if not anonymous.\n " nullable: true IJsonResponseOfString: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: string description: "The payload data.\n " nullable: true errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' JwtRefreshRequest: type: object description: "Defines the nsk token request to gain access to the API.\n \ \ " additionalProperties: false properties: applicationName: type: string description: "The application name if should change from the original token.\n\ \ " nullable: true cultureCode: type: string description: "The optional culture code.\n " nullable: true newSession: type: boolean description: "Create a new session and keep the old one alive.\n \ \ " IJsonResponseOfMultiFactorJwtResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/MultiFactorJwtResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' MultiFactorJwtResponse: type: object description: "Represents the MFA response model.\n " additionalProperties: false properties: token: type: string description: "The JWT.\n " nullable: true cultureCode: type: string description: "The culture code set for this token.\n " nullable: true currencyCode: type: string description: "The currency code set for this token.\n " nullable: true roleCode: type: string description: "The role code set for this token.\n " nullable: true locationCode: type: string description: "The location code.\n " nullable: true domainCode: type: string description: "The domain code.\n " nullable: true organizationCode: type: string description: "The organization code.\n " nullable: true expires: type: string description: "The absolute expiration time.\n " format: date-time nullable: true userKey: type: string description: "The user key, if not anonymous.\n " nullable: true personKey: type: string description: "The person key, if not anonymous.\n " nullable: true multiFactorRequired: description: "The data returned if a multifactor authentication is needed.\n\ \ " nullable: true $ref: '#/components/schemas/MultiFactorResponse' MultiFactorResponse: type: object description: "Represents the MFA response model.\n " additionalProperties: false properties: challengeId: type: string description: "The identifier for this MFA request.\n " nullable: true requiresRegistration: type: boolean description: "Requires registration for Multi-Factor Authentication. See\ \ POST /token/multifactor\n " requiresChallengeCode: type: boolean description: "Requires challenge code for Multi-Factor Authentication. Check\ \ your authentication method and resend the request\nwith the challenge\ \ code.\n " types: type: array description: "The Multi-Factor Authentication types allowed to authenticate\ \ with.\n " nullable: true items: $ref: '#/components/schemas/MultiFactorType' MultiFactorType: type: integer description: "The Multi-Factor Authentication types allowed to authenticate\ \ with.\n \n\n0 = Email\n1 = ShortMessageService\n2 = TimeBasedOneTimePassword" x-enumNames: - Email - ShortMessageService - TimeBasedOneTimePassword enum: - 0 - 1 - 2 JwtRequest: type: object description: "Defines the nsk token request to gain access to the API.\n \ \ " additionalProperties: false required: - credentials properties: applicationName: type: string description: "The optional name of the calling application.\n \ \ " nullable: true credentials: description: "The nsk user login credentials.\n " $ref: '#/components/schemas/JwtCredentials' cultureCode: type: string description: "The optional culture code.\n " nullable: true multiFactor: description: "The multifactor authentication request data.\n " nullable: true $ref: '#/components/schemas/MultiFactorRequest' JwtCredentials: type: object description: "Represents the base credential model.\n " additionalProperties: false required: - password - domain properties: username: type: string description: "The unique username.\n " nullable: true alternateIdentifier: type: string description: "Alternate identifier that can be used in place of the username.\n\ \ " nullable: true password: type: string description: "The unique password.\n " minLength: 1 domain: type: string description: "The domain the user exists in.\n " minLength: 1 location: type: string description: "The location the user exists in.\n " nullable: true loginRole: type: string description: "The role to log in as.\n " nullable: true MultiFactorRequest: type: object description: "Multifactor Request\n " additionalProperties: false properties: challengeCode: type: string description: "The challenge code if multifactor authentication is required.\n\ \ " maxLength: 20 minLength: 0 nullable: true challengeId: type: string description: "The identifier for a multifactor request.\n " maxLength: 20 minLength: 0 nullable: true requestIdentityToken: type: boolean description: "Set to true to request an Identity token. This token type\ \ is exclusively to skip MFA after logging in with MFA\ninitially. In\ \ order to make other API calls, this token must be passed in and upgraded\ \ to a normal \"short-lived\"\ntoken. If RequestIdentityToken is set to\ \ false, a normal \"short-lived\" token will be returned.\n \ \ " IJsonResponseOfMultiFactorRegisterResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/MultiFactorRegisterResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' MultiFactorRegisterResponse: type: object description: "Represents the register response model.\n " additionalProperties: false properties: qrCodeUrl: type: string description: "Qr code embedded png url if the request was set for TOTP registration.\n\ \ " nullable: true challengeId: type: string description: "The identifier for this MFA request.\n " nullable: true MultiFactorRegisterRequest: type: object description: "Represents the MFA response model.\n " additionalProperties: false required: - credentials properties: credentials: description: "The nsk user login credentials.\n " $ref: '#/components/schemas/RegisterCredentials' registration: description: "Data needed to register a source and to later verify.\n \ \ " nullable: true $ref: '#/components/schemas/MultiFactorRegistration' verify: description: "Additional data needed for the second step to verify registration.\n\ \ " nullable: true $ref: '#/components/schemas/MultiFactorRequest' RegisterCredentials: type: object description: "Represents the base credential model for registering.\n \ \ " additionalProperties: false required: - password - domain properties: username: type: string description: "The unique username.\n " nullable: true alternateIdentifier: type: string description: "Alternate identifier that can be used in place of the username.\n\ \ " nullable: true password: type: string description: "The unique password.\n " minLength: 1 domain: type: string description: "The domain the user exists in.\n " minLength: 1 MultiFactorRegistration: type: object description: "Represents the MFA registration model.\n " additionalProperties: false properties: type: description: "The method to be used for multifactor authentication\n \ \ " $ref: '#/components/schemas/MultiFactorType' phone: type: string description: "Required for SMS type MFA.\n " format: phone nullable: true email: type: string description: "Required for email type MFA.\n " format: email nullable: true JwtImpersonateRequest: type: object description: "Defines the nsk token request to gain access to the API.\n \ \ " additionalProperties: false properties: applicationName: type: string description: "The application name if should change from the original token.\n\ \ " nullable: true cultureCode: type: string description: "The optional culture code.\n " nullable: true newSession: type: boolean description: "Create a new session and keep the old one alive.\n \ \ " roleCode: type: string description: "The alternate role code for impersonation scenarios.\n \ \ " nullable: true IJsonResponseOfJwtDetailsResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/JwtDetailsResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' JwtDetailsResponse: type: object description: "Represents the JWT details response model.\n " additionalProperties: false properties: token: type: string description: "The JWT.\n " nullable: true cultureCode: type: string description: "The culture code set for this token.\n " nullable: true currencyCode: type: string description: "The currency code set for this token.\n " nullable: true roleCode: type: string description: "The role code set for this token.\n " nullable: true locationCode: type: string description: "The location code.\n " nullable: true domainCode: type: string description: "The domain code.\n " nullable: true organizationCode: type: string description: "The organization code.\n " nullable: true expires: type: string description: "The absolute expiration time.\n " format: date-time nullable: true userKey: type: string description: "The user key, if not anonymous.\n " nullable: true personKey: type: string description: "The person key, if not anonymous.\n " nullable: true applicationName: type: string description: "The logged-in application name.\n " nullable: true username: type: string description: "The logged-in username.\n " nullable: true channel: description: "The logged-in channel.\n " $ref: '#/components/schemas/ChannelType' systemName: description: "The logged-in system name.\n " $ref: '#/components/schemas/SystemName' type: description: "The logged-in user's session permission type.\n \ \ " $ref: '#/components/schemas/SessionPermissionType' SystemName: type: integer description: "Defines the system names.\n \n\n0 = Default\n1 = WinRez\n\ 2 = FareManager\n3 = ScheduleManager\n4 = WinManager\n5 = ConsoleRez\n6 =\ \ WebRez\n7 = WebServicesApi\n8 = WebServicesEsc\n9 = InternalService\n10\ \ = WebReporting\n11 = TaxAndFeeManager\n12 = Dcs\n13 = DcsKiosk\n14 = FareManagerPlus\n\ 15 = DotRez\n16 = Loyalty\n17 = Ndc\n18 = Unknown\n19 = CallCenter\n20 = Ibe\n\ 21 = Mobile\n22 = Ivr\n23 = ChatBot\n24 = Kiosk\n25 = AgencyIbe\n26 = SkyLedger\n\ 27 = SkyPrice\n28 = TcDotRez\n29 = TcInternalService\n30 = TcManagementApp\n\ 31 = TcStorefront\n32 = TcSupplierPortal\n33 = GssManagementConsole\n34 =\ \ NdcInterline\n35 = DataIntegration\n36 = DataIntegrationApi\n100 = UserDefined" x-enumNames: - Default - WinRez - FareManager - ScheduleManager - WinManager - ConsoleRez - WebRez - WebServicesApi - WebServicesEsc - InternalService - WebReporting - TaxAndFeeManager - Dcs - DcsKiosk - FareManagerPlus - DotRez - Loyalty - Ndc - Unknown - CallCenter - Ibe - Mobile - Ivr - ChatBot - Kiosk - AgencyIbe - SkyLedger - SkyPrice - TcDotRez - TcInternalService - TcManagementApp - TcStorefront - TcSupplierPortal - GssManagementConsole - NdcInterline - DataIntegration - DataIntegrationApi - UserDefined 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 - 100 SessionPermissionType: type: integer description: "Defines the sessions permission type.\n \n\n0 = Unknown\n\ 1 = Customer\n2 = Anonymous\n3 = Agent" x-enumNames: - Unknown - Customer - Anonymous - Agent enum: - 0 - 1 - 2 - 3 IJsonResponseOfNskSessionContext: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/NskSessionContext' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' NskSessionContext: type: object description: "Defines the nsk current session context.\n " additionalProperties: false properties: defaultCultureCode: type: string description: "The users default culture code.\n " nullable: true defaultCurrencyCode: type: string description: "The users default currency code.\n " nullable: true type: description: "The type of session permissions based on the logged-in user.\n\ \ " $ref: '#/components/schemas/SessionPermissionType' hasBookingInState: type: boolean description: "True if the booking exists in NewSkies for the session.\n\ \ " isPendingLogin: type: boolean description: "Flag indicating if the session is pending login.\n \ \ " isVirtual: type: boolean description: "Flag indicating if the session is a virtual user. This check\ \ is specific for a virtual, anonymous user only.\nTo check if the session\ \ (non-anonymous user) is virtual, retrieve the token details and look\ \ at the server context\nID--if it is less than zero, the session is virtual.\n\ \ " identity: description: "The logged in users identity.\n " nullable: true $ref: '#/components/schemas/UserIdentity' serverContext: description: "The server's session context.\n " nullable: true $ref: '#/components/schemas/NskServerContext' roles: description: "The roles applied to the current session.\n " nullable: true $ref: '#/components/schemas/NskRoles' UserIdentity: type: object description: "Defines the logged in users identity.\n " additionalProperties: false properties: userKey: type: string description: "The unique user key.\n " nullable: true personKey: type: string description: "The unique person key.\n " nullable: true domain: type: string description: "The domain code the user exists in.\n " nullable: true organization: type: string description: "The organization code the user is apart of.\n " nullable: true NskServerContext: type: object description: "Defines the NSK server context.\n " additionalProperties: false properties: id: type: integer description: "The servers session ID.\n " format: int64 token: type: string description: "The servers secure token.\n " nullable: true systemName: description: "The acting system name.\n " $ref: '#/components/schemas/SystemName' channel: description: "The acting channel type.\n " $ref: '#/components/schemas/ChannelType' applicationName: type: string description: "The acting application name.\n " nullable: true locationCode: type: string description: "The acting location code.\n " nullable: true NskRoles: type: object description: "Defines the NSK role.\n " additionalProperties: false properties: inBaseRole: type: boolean description: "Flag indicating if in the base role.\n " acting: description: "The acting role.\n " nullable: true $ref: '#/components/schemas/RoleBase' base: description: "The base/original role.\n " nullable: true $ref: '#/components/schemas/RoleBase' RoleBase: type: object description: "Defines the base role.\n " additionalProperties: false properties: roleCode: type: string description: "The unique role code.\n " nullable: true name: type: string description: "The role's name.\n " nullable: true IJsonResponseOfMultiFactorTokenResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/MultiFactorTokenResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' MultiFactorTokenResponse: type: object description: "Represents the JWT response model.\n " additionalProperties: false properties: token: type: string description: "The generated token.\n " nullable: true idleTimeoutInMinutes: type: integer description: "The number of minutes the token can be idle before it times\ \ out.\n " format: int32 multiFactorRequired: description: "Multi-Factor Authentication details if enabled for the user.\n\ \ " nullable: true $ref: '#/components/schemas/MultiFactorResponse' NskTokenRequestv2: type: object description: "Defines the nsk token request to gain access to the API.\n \ \ " additionalProperties: false properties: applicationName: type: string description: "The optional name of the calling application.\n \ \ " nullable: true credentials: description: "The nsk user login credentials.\n " nullable: true $ref: '#/components/schemas/CredentialsBase' multiFactor: description: "The multifactor authentication request data.\n " nullable: true $ref: '#/components/schemas/MultiFactorRequest' CredentialsBase: type: object description: "Represents the base credential model.\n " additionalProperties: false properties: username: type: string description: "The unique username.\n " nullable: true alternateIdentifier: type: string description: "Alternate identifier that can be used in place of the username.\n\ \ " nullable: true password: type: string description: "The unique password.\n " nullable: true domain: type: string description: "The domain the user exists in.\n " nullable: true location: type: string description: "The location the user exists in.\n " nullable: true loginRole: type: string description: "The role to log in as.\n " nullable: true IJsonResponseOfAddNewsResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AddNewsResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AddNewsResponse: type: object description: "The add news response.\n " additionalProperties: false properties: news: description: "The news added.\n " nullable: true $ref: '#/components/schemas/News' News: type: object description: "The News (FYI Notes) content item.\n " additionalProperties: false properties: contentId: type: integer description: "The unique identifier for news and other content types.\n\ \ " format: int64 name: type: string description: "The name of the content.\n " nullable: true description: type: string description: "The description of the content.\n " nullable: true createdUserKey: type: string description: "The user key of the creating agent.\n " nullable: true createdDate: type: string description: "The date the content was created.\n " format: date-time nullable: true dataType: description: "The news content data type.\n " $ref: '#/components/schemas/GeneralContentDataType' size: type: integer description: "The content data size.\n " format: int64 type: description: "The news type.\n " $ref: '#/components/schemas/NewsType' organizationCode: type: string description: "The organization code. See /organizations2 for the valid codes.\n\ \ " nullable: true domainCode: type: string description: "The domain code. See /resources/Domains for the valid codes.\n\ \ " nullable: true departmentCode: type: string description: "The department code. See /resources/Departments for the valid\ \ codes.\n " nullable: true roleCode: type: string description: "The role code. See /resources/Roles for the valid codes.\n\ \ " nullable: true effectiveDate: type: string description: "The date this information will be available in the system.\ \ Indicates the date that this message will be displayed to agents.\n\ \ " format: date-time nullable: true discontinueDate: type: string description: "Indicates the date that this message will stop appearing to\ \ agents. A null value will indicate that the message should stay active\ \ in the system.\n " format: date-time nullable: true retentionDate: type: string description: "Indicates the length of time this message will be retained\ \ in the system. Use this selection for FYIs to save in the system but\ \ not make viewable.\nA null value will indicate that the message will\ \ remain in the database.\n " format: date-time nullable: true GeneralContentDataType: type: integer description: "Defines the general content data type enumeration.\n \ \ \n\n1 = Text\n2 = RichTextFormat\n3 = ImageJpg\n4 = ImageGif\n5 = ImageBmp\n\ 6 = ImagePng\n7 = WordDoc\n8 = Html\n9 = Pdf\n10 = Uri\n11 = WordDocx" x-enumNames: - Text - RichTextFormat - ImageJpg - ImageGif - ImageBmp - ImagePng - WordDoc - Html - Pdf - Uri - WordDocx enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 NewsType: type: integer description: "Indicates how often the news content item will be available for\ \ the user.\n \n\n1 = Alert\n2 = OneTimeRead\n3 = Daily\n4 = NoAlert" x-enumNames: - Alert - OneTimeRead - Daily - NoAlert enum: - 1 - 2 - 3 - 4 AddNewsRequest: type: object description: "The add news request.\n " additionalProperties: false required: - name - type - dataType - data properties: domainCode: type: string description: "The domain code. See /resources/Domains for the valid codes.\n\ \ " maxLength: 3 minLength: 0 nullable: true departmentCode: type: string description: "The department code. See /resources/Departments for the valid\ \ codes.\n " maxLength: 4 minLength: 0 nullable: true roleCode: type: string description: "The role code. See /resources/Roles for the valid codes.\n\ \ " maxLength: 4 minLength: 0 nullable: true name: type: string description: "The news name.\n " minLength: 1 description: type: string description: "The content description.\n " nullable: true type: description: "The news type.\n " $ref: '#/components/schemas/NewsType' effectiveDate: type: string description: "The date this information will be available in the system.\ \ Indicates the date that this message will display to agents. Defaults\ \ to today if not provided.\n " format: date-time nullable: true discontinueDate: type: string description: "Indicates the date that this message will stop appearing to\ \ agents. A null value will indicate that the message should stay active\ \ in the system.\n " format: date-time nullable: true retentionDate: type: string description: "Indicates the length of time this message will be retained\ \ in the system. Use this selection for FYIs to save in the system but\ \ not make viewable.\nA null value will indicate that the message will\ \ remain in the database.\n " format: date-time nullable: true dataType: description: "The content data type. This will only support text based content\ \ data types.\n " $ref: '#/components/schemas/CreateContentDataType' data: type: string description: "The content data. This will only support text based content\ \ from Text, RichTextFormat, HTML, and URI data types.\n " minLength: 1 CreateContentDataType: type: integer description: "Defines the create content data type enumeration. This is a subset\ \ of the general content data \ntype enum to be used only for content creation\ \ and will only support text based data types.\n \n\n1 = Text\n\ 2 = RichTextFormat\n8 = Html\n10 = Uri" x-enumNames: - Text - RichTextFormat - Html - Uri enum: - 1 - 2 - 8 - 10 IJsonResponseOfPagedFindNewsResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PagedFindNewsResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PagedFindNewsResponse: type: object description: "The paged find news response.\n " additionalProperties: false properties: newsList: type: array description: "The list of news.\n " nullable: true items: $ref: '#/components/schemas/FindNewsItem' totalCount: type: integer description: "The total count of news.\n " format: int32 lastPageKey: type: string description: "The LastPageKey, where to start paged query.\n " nullable: true FindNewsItem: type: object description: "The News (FYI Notes) content item.\n " additionalProperties: false properties: contentId: type: integer description: "The unique identifier for news and other content types.\n\ \ " format: int64 name: type: string description: "The name of the content.\n " nullable: true description: type: string description: "The description of the content.\n " nullable: true createdUserKey: type: string description: "The user key of the creating agent.\n " nullable: true createdDate: type: string description: "The date the content was created.\n " format: date-time nullable: true dataType: description: "The news content data type.\n " $ref: '#/components/schemas/GeneralContentDataType' size: type: integer description: "The content data size.\n " format: int64 type: description: "The news type.\n " $ref: '#/components/schemas/NewsType' organizationCode: type: string description: "The organization code. See /organizations2 for the valid codes.\n\ \ " nullable: true domainCode: type: string description: "The domain code. See /resources/Domains for the valid codes.\n\ \ " nullable: true departmentCode: type: string description: "The department code. See /resources/Departments for the valid\ \ codes.\n " nullable: true roleCode: type: string description: "The role code. See /resources/Roles for the valid codes.\n\ \ " nullable: true effectiveDate: type: string description: "The date this information will be available in the system.\ \ Indicates the date that this message will be displayed to agents.\n\ \ " format: date-time nullable: true discontinueDate: type: string description: "Indicates the date that this message will stop appearing to\ \ agents. A null value will indicate that the message should stay active\ \ in the system.\n " format: date-time nullable: true retentionDate: type: string description: "Indicates the length of time this message will be retained\ \ in the system. Use this selection for FYIs to save in the system but\ \ not make viewable.\nA null value will indicate that the message will\ \ remain in the database.\n " format: date-time nullable: true data: type: string description: "The content data. This will be null if the content data type\ \ is not text-based.\n " nullable: true FindNewsType: type: integer description: "Indicates how often the news content item will be available for\ \ the user.\n \n\n0 = All\n1 = Alert\n2 = OneTimeRead\n3 = Daily\n\ 4 = NoAlert" x-enumNames: - All - Alert - OneTimeRead - Daily - NoAlert enum: - 0 - 1 - 2 - 3 - 4 NewsRequestType: type: integer description: "News request type enumeration.\n \n\n0 = Default\n\ 1 = Unread\n2 = UnreadAlert\n3 = UnreadDailyAndOneTimeRead" x-enumNames: - Default - Unread - UnreadAlert - UnreadDailyAndOneTimeRead enum: - 0 - 1 - 2 - 3 IJsonResponseOfTripDetails: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/TripDetails' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TripDetails: type: object description: "Represents the trip status details version two model.\n \ \ " additionalProperties: false properties: legCrossReferences: type: array description: "Represents the leg cross references.\n " nullable: true items: $ref: '#/components/schemas/LegCrossReference' cabinDetails: type: array description: "Represents the list of cabin details.\n " nullable: true items: $ref: '#/components/schemas/CabinDetails' checkinLid: type: integer description: "Represents the total number of passengers allowed to checkin.\n\ \ " CabinDetails: type: object description: "Represents the cabin details model.\n " additionalProperties: false properties: cabinOfService: type: string description: "Represents the code for the cabin of service.\nPlease note\ \ that this should be a char and not a string.\n " maxLength: 1 nullable: true adjustedSeatCount: type: integer description: "Represents the adjusted seat count of the leg for the cabin.\n\ \ " format: int32 maximumSeatCount: type: integer description: "Represents the maximum number of seats authorized to be sold\ \ on a flight.\n " format: int32 seatsSold: type: integer description: "Represents the number of seats that have been sold.\n \ \ " format: int32 TripInformationStatusRequestBase: type: object description: "Represents the base trip information status request model.\n \ \ " additionalProperties: false properties: departureStatus: description: "The departure status.\n " nullable: true $ref: '#/components/schemas/DepartureStatus' departureGate: type: string description: "The estimated departure gate.\n " nullable: true actualDepartureGate: type: string description: "Represents the actual departure gate of the trip.\n \ \ " maxLength: 4 minLength: 0 nullable: true arrivalStatus: description: "The arrival status.\n " nullable: true $ref: '#/components/schemas/ArrivalStatus' arrivalGate: type: string description: "The estimated arrival gate.\n " nullable: true actualArrivalGate: type: string description: "Represents the actual arrival gate of the trip.\n \ \ " maxLength: 4 minLength: 0 nullable: true baggageClaim: type: string description: "The baggage claim.\n " nullable: true tripOperationTimes: description: "The request to update the trip operation times.\n \ \ " nullable: true $ref: '#/components/schemas/TripOperationTimesEditRequest' tripFuelDetails: description: "The trip fuel details.\n " nullable: true $ref: '#/components/schemas/TripFuelDetails' irop: type: boolean description: "Indicates if the leg is designated as IROP.\n " nullable: true tailNumber: type: string description: "The tail number of the aircraft. See /resources/tailNumbers\ \ for the list of all available tail numbers.\n " maxLength: 10 minLength: 0 nullable: true passengerCounts: description: "The number of passengers and crew on board.\n " nullable: true $ref: '#/components/schemas/TripPassengerCountsEditRequest' TripOperationTimesEditRequest: type: object description: "Represents the edit request for flight operation time events.\n\ \ " additionalProperties: false properties: touchDownTimes: description: "Represents the touch down times for this flight operation.\n\ \ " nullable: true $ref: '#/components/schemas/TripOperationEvents' onBlockTimes: description: "Represents the on-block times for this flight operation.\n\ \ " nullable: true $ref: '#/components/schemas/TripOperationEvents' departureTimes: description: "Represents the departure times for this flight operation.\n\ \ " nullable: true $ref: '#/components/schemas/DepartureEvent' 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 scheduledArrivalTime: type: string description: "Represents the scheduled arrival time for this flight operation.\n\ \ " format: date-time nullable: true TripOperationEvents: type: object description: "Represents the flight operation time events for an estimated,\n\ actual, and forced time event.\n " additionalProperties: false properties: forced: type: string description: "Represents the forced time for this event type.\n \ \ " format: date-time nullable: true actual: type: string description: "Represents the actual time for this event type.\n \ \ " format: date-time nullable: true estimated: type: string description: "Represents the estimated time for this event type.\n \ \ " format: date-time nullable: true TripFuelDetails: type: object description: "Represents the fuel information for a trip.\n " additionalProperties: false properties: fuelOnboardOut: type: integer description: "Represents the amount of fuel onboard the aircraft/equipment\ \ upon departure.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true fuelOnboardIn: type: integer description: "Represents the amount of fuel onboard the aircraft/equipment\ \ upon arrival.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true upLiftFuel: type: integer description: "Represents the amount of fuel uplifted to the aircraft/equipment.\n\ \ " format: int32 maximum: 2147483647.0 minimum: 0.0 nullable: true TripPassengerCountsEditRequest: type: object description: "The number of passengers and crew in the flight.\n " additionalProperties: false properties: infantCount: type: integer description: "The number of infants not occupying a seat.\n " maximum: 32767.0 minimum: 0.0 nonRevenueCount: type: integer description: "The number of non-revenue passengers.\n " maximum: 32767.0 minimum: 0.0 revenueCount: type: integer description: "The number of revenue passengers.\n " maximum: 32767.0 minimum: 0.0 cockpitCrewCount: type: integer description: "The number of crew in the cockpit.\n " maximum: 32767.0 minimum: 0.0 cabinCrewCount: type: integer description: "The number of crew in the cabin.\n " maximum: 32767.0 minimum: 0.0 IJsonResponseOfIListOfScheduleDetail: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ScheduleDetail' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ScheduleDetail: type: object description: "Market detail contains the abstracted market data describing the\ \ earliest and\nlatest STD.\n " additionalProperties: false properties: departureDate: type: string description: "Date this market detail corresponds to.\n " format: date-time earliest: type: string description: "Earliest std on this departure date.\n " format: date-time latest: type: string description: "Latest std on this deparure date.\n " format: date-time flights: type: integer description: "Number of flights on the given departure date.\n \ \ " format: int64 IJsonResponseOfIListOfItineraryVariation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ItineraryVariation' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ItineraryVariation: type: object description: "Defines the schedule itinerary variation.\n " additionalProperties: false required: - flightIdentifier - itineraryLegs properties: flightIdentifier: description: "The identifier of the flight to be added.\n " $ref: '#/components/schemas/TransportationIdentifier' itineraryLegs: type: array description: "The legs of the flight to be added.\n " items: $ref: '#/components/schemas/ScheduleItineraryLeg' ScheduleItineraryLeg: type: object description: "Defines the itinerary leg for creating flights.\n " additionalProperties: false required: - beginDate - origin - destination - equipmentType - salesConfigurationCode properties: beginDate: type: string description: "The start date of the flight operation.\n " format: date-time minLength: 1 origin: type: string description: "The departure station code.\n " maxLength: 3 minLength: 3 destination: type: string description: "The arrival station code.\n " maxLength: 3 minLength: 3 scheduledDepartureTime: type: integer description: "The leg departure time in minutes.\n " maximum: 1440.0 minimum: 0.0 departureTimeVariant: type: integer description: "The leg departure local time variant (LTV).\n " maximum: 1440.0 minimum: -1440.0 scheduledArrivalTime: type: integer description: "The leg arrival time in minutes.\n " maximum: 1440.0 minimum: 0.0 arrivalTimeVariant: type: integer description: "The leg arrival local time variant (LTV).\n " maximum: 1440.0 minimum: -1440.0 equipmentType: type: string description: "The type of equipment for the leg.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: string description: "The suffix associated with the equipment type.\n \ \ " maxLength: 3 minLength: 0 nullable: true salesConfigurationCode: type: string description: "The sales configuration code for the leg, also known as PRBC\ \ (Passenger Reservation Booking Configuration) code.\n " maxLength: 8 minLength: 0 eTicket: type: boolean description: "Indicates if the e-ticket is enabled for the leg.\n \ \ " CommitItineraryVariationRequest: type: object description: "Defines the commit itinerary variation request.\n " additionalProperties: false properties: forGeneralUse: type: boolean description: "Indicates if the flight will be available for general use.\n\ \ " itineraryVariation: description: "The itinerary variation.\n " nullable: true $ref: '#/components/schemas/ItineraryVariation' InventorySeatPropertyBase: type: object description: "Represents the base inventory seat property to be committed.\n\ \ " additionalProperties: false required: - code - value properties: code: type: string description: "The type code for the inventory seat property.\n \ \ " minLength: 1 value: type: string description: "The value code for the inventory seat property.\n \ \ " minLength: 1 IJsonResponseOfIDictionaryOfStringAndListOfInventorySeatPropertyBase: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/InventorySeatPropertyBase' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfTripInformationLegv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/TripInformationLegv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TripInformationLegv2: type: object description: "Represents the trip information leg model.\n " additionalProperties: false properties: legKey: type: string description: "The unique identifier for the leg.\n " nullable: true legDetails: description: "The additional details for the leg.\n " nullable: true $ref: '#/components/schemas/LegDetailsv2' seatsSold: description: "Information relating to the number of seats sold for the leg.\n\ \ " nullable: true $ref: '#/components/schemas/LegSeatsSold' designator: description: "The transportation designator.\n " nullable: true $ref: '#/components/schemas/TransportationDesignator' identifier: description: "The transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' operatingInformation: description: "The leg's \"operated by\" information.\n " nullable: true $ref: '#/components/schemas/OperatingInformation' LegDetailsv2: type: object description: "Represents the leg details model.\n " additionalProperties: false properties: departureTimeUtc: type: string description: "The departure time using the time variant in universal time.\n\ \ " format: date-time nullable: true arrivalTimeUtc: type: string description: "The arrival time using the time variant in universal time.\n\ \ " format: date-time nullable: true adjustedCapacity: type: integer description: "The leg adjusted capacity.\n " arrivalTerminal: type: string description: "The leg arrival terminal.\n " maxLength: 2 minLength: 0 nullable: true arrivalTimeVariant: type: integer description: "The leg arrival Local Time Variant (LTV).\n " capacity: type: integer description: "The leg capacity.\n " nullable: true changeOfDirection: type: boolean description: "A value indicating whether the leg has a change of direction.\n\ \ " codeShareIndicator: description: "The leg code share indicator.\n " $ref: '#/components/schemas/CodeShareIndicator' departureTerminal: type: string description: "The leg departure terminal.\n " maxLength: 2 minLength: 0 nullable: true departureTimeVariant: type: integer description: "The leg departure Local Time Variant (LTV).\n " equipmentType: type: string description: "The leg type of the equipment.\n " maxLength: 3 minLength: 0 nullable: true equipmentTypeSuffix: type: string description: "The leg equipment type suffix.\n " maxLength: 3 minLength: 0 nullable: true eTicket: type: boolean description: "A value indicating whether this leg is an e-ticketed leg.\n\ \ " irop: type: boolean description: "Gets or sets a value indicating whether this leg is an IROP.\n\ \ " lid: type: integer description: "The leg's lid.\n " marketingCode: type: string description: "The leg marketing code.\n " nullable: true marketingOverride: type: boolean description: "A value indicating whether the leg has a marketing override.\n\ \ " onTime: description: "The indicator for on-time perfomance of the leg.\n \ \ " $ref: '#/components/schemas/OnTime' arrivalTime: type: string description: "The leg passenger standard time of arrival (STA).\n \ \ " format: date-time nullable: true departureTime: type: string description: "The leg passenger standard time of departure (STD).\n \ \ " format: date-time nullable: true prbcCode: type: string description: "The leg PRBC code.\n " maxLength: 8 minLength: 0 nullable: true status: description: "The legs status.\n " $ref: '#/components/schemas/LegStatus' subjectToGovernmentApproval: type: boolean description: "A value indicating whether the leg is subject to government\ \ approval.\n " jointOpInfo: type: string description: "The identifier if legs are jointly operated by two or more\ \ carriers.\n " maxLength: 20 minLength: 0 nullable: true transitLayover: type: integer description: "The waiting period in number of days between flights.\n \ \ " transitDays: type: integer description: "The number of transit days for the leg.\n " OnTime: type: integer description: "Represents the likelihood of a leg being on time.\n \ \ \n\n0 = Above0Percent\n1 = Above10Percent\n2 = Above20Percent\n3 = Above30Percent\n\ 4 = Above40Percent\n5 = Above50Percent\n6 = Above60Percent\n7 = Above70Percent\n\ 8 = Above80Percent\n9 = Above90Percent\n10 = NotApplicable\n11 = Unknown" x-enumNames: - Above0Percent - Above10Percent - Above20Percent - Above30Percent - Above40Percent - Above50Percent - Above60Percent - Above70Percent - Above80Percent - Above90Percent - NotApplicable - Unknown enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 LegSeatsSold: type: object description: "Represents the leg seats sold model.\n " additionalProperties: false properties: total: type: integer description: "The number of seats sold.\n " throughTotal: type: integer description: "The number of seats sold as part of a through flight.\n \ \ " nonStopTotal: type: integer description: "The number of seats sold as part of a non-stop flight.\n \ \ " connectTotal: type: integer description: "The number of seats sold as part of a connecting flight.\n\ \ " confirmed: type: integer description: "The number of confirmed seats sold in this leg.\n \ \ " TripInformationLegQuery: type: object description: "The trip information leg query model contains data to perform\ \ a\ntrip information search.\n " additionalProperties: false required: - beginDate properties: beginDate: type: string description: "The starting date of the trip information search.\n \ \ " format: date-time minLength: 1 endDate: type: string description: "The end date of the trip information search.\n " format: date-time nullable: true startTimeInterval: type: string description: "The starting time of the trip information search.\n \ \ " format: duration nullable: true endTimeInterval: type: string description: "The end time of the trip information search.\n " format: duration nullable: true identifier: type: string description: "The transportation identifier, such as a flight number.\n\ \ " maxLength: 4 minLength: 0 nullable: true carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 nullable: true daysOfWeek: type: array description: "The days of the week to include in the provided date range.\n\ \ " nullable: true items: $ref: '#/components/schemas/DayOfWeek' equipmentFilter: description: "The optional equipment filter for the search.\n \ \ " nullable: true $ref: '#/components/schemas/EquipmentFilter' originStations: type: array description: "The list of departure stations.\n " nullable: true items: type: string destinationStations: type: array description: "The list of arrival stations.\n " nullable: true items: type: string opSuffix: type: string description: "The operational suffix.\nPlease note that this should be a\ \ char and not a string.\n " maxLength: 1 nullable: true excludeMarketedFlights: type: boolean description: "When set to true, all flights with a non-blank operating carrier\ \ are filtered out of the result.\nThe DB calls the parameter noOperatingCarrier.\n\ \ " EquipmentFilter: type: object description: "Represents a filter for equipment type.\n " additionalProperties: false required: - equipmentType properties: equipmentType: type: string description: "The type of equipment for the journey.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: string description: "The suffix associated with the equipment type.\n \ \ " maxLength: 3 minLength: 0 nullable: true IJsonResponseOfTripStatusv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/TripStatusv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TripStatusv2: type: object description: "Represents the trip status version two model.\n " additionalProperties: false properties: tripStatusKey: type: string description: "Represents the trip status key.\n " nullable: true operationDetails: description: "Represents the operation details.\n " nullable: true $ref: '#/components/schemas/OperationDetails' originDetails: description: "Represents details related to the trip origin location.\n\ \ " nullable: true $ref: '#/components/schemas/OriginDetails' destinationDetails: description: "Represents details related to the trip destination location.\n\ \ " nullable: true $ref: '#/components/schemas/DestinationDetails' modifiedAgentName: type: string description: "The name of the agent that last modified this data.\n \ \ " maxLength: 64 minLength: 0 nullable: true verified: type: boolean description: "Represents the verified bit.\n " irop: type: boolean description: "Represents the IROP flag.\n " modifiedDate: type: string description: "The date and time (in UTC) that the trip status was modified.\n\ \ " format: date-time nullable: true OperationDetails: type: object description: "Represents the operation details model.\n " additionalProperties: false properties: tailNumber: type: string description: "Represents the tail number for the aircraft.\n " maxLength: 10 minLength: 0 nullable: true equipmentType: type: string description: "Represents the equipment type for the leg.\n " maxLength: 3 minLength: 1 nullable: true equipmentTypeSuffix: type: string description: "Represents the equipment type suffix for the leg.\n \ \ " maxLength: 3 minLength: 0 nullable: true status: description: "Represents the trip status.\n " $ref: '#/components/schemas/LegStatus' identifier: description: "Represents the transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' tripOperationTimes: description: "Represents the trip operation time events.\n " nullable: true $ref: '#/components/schemas/TripOperationTimes' counts: description: "Represents the various counts related to the operation.\n\ \ " nullable: true $ref: '#/components/schemas/OperationCounts' delays: type: array description: "A list of trip operation delays.\n " nullable: true items: $ref: '#/components/schemas/TripOperationDelay' payloads: type: array description: "Represents the list of trip operation payloads.\n \ \ " nullable: true items: $ref: '#/components/schemas/TripOperationPayload' crewList: type: array description: "Represents the list of crew members.\n " nullable: true items: $ref: '#/components/schemas/TripOperationCrew' comments: type: array description: "Represents the comments related to this trip operation.\n\ \ " nullable: true items: $ref: '#/components/schemas/TripOperationComment' historyList: type: array description: "Represents the history of this trip operation.\n \ \ " nullable: true items: $ref: '#/components/schemas/TripOperationHistory' TripOperationTimes: type: object description: "Represents the flight operation time events. Null property values\ \ indicate\nthat there is no recorded time event for the given property name.\n\ \ " additionalProperties: false properties: touchDownTimes: description: "Represents the touch down times for this flight operation.\n\ \ " nullable: true $ref: '#/components/schemas/TripOperationEvents' onBlockTimes: description: "Represents the on-block times for this flight operation.\n\ \ " nullable: true $ref: '#/components/schemas/TripOperationEvents' departureTimes: description: "Represents the departure times for this flight operation.\n\ \ " nullable: true $ref: '#/components/schemas/DepartureEvent' 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 scheduledArrivalTime: type: string description: "Represents the scheduled arrival time for this flight operation.\n\ \ " format: date-time nullable: true lastModifiedDate: type: string description: "Represents the date the object was last modified.\n \ \ " format: date-time nullable: true OperationCounts: type: object description: "Represents the operation counts model.\n " additionalProperties: false properties: boardingCount: type: integer description: "Represents the number of passengers that have boarded the\ \ trip equipment.\n " maximum: 32767.0 minimum: 0.0 boardingSequence: type: integer description: "Represents the boarding sequence number. Starts at 1 for\ \ each leg.\n " maximum: 32767.0 minimum: 0.0 infantCount: type: integer description: "Represents the number of infants not occupying a seat.\n \ \ " maximum: 32767.0 minimum: 0.0 nonRevenueCount: type: integer description: "Represents the number of non-revenue passengers.\n \ \ " maximum: 32767.0 minimum: 0.0 revenueCount: type: integer description: "Represents the number of revenue passengers.\n " maximum: 32767.0 minimum: 0.0 checkInCount: type: integer description: "Represents the number of passengers that have checked-in.\n\ \ " maximum: 32767.0 minimum: 0.0 fuelOnboardOut: type: integer description: "Represents the amount of fuel onboard the aircraft/equipment\ \ upon departure.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 fuelOnboardIn: type: integer description: "Represents the amount of fuel onboard the aircraft/equipment\ \ upon arrival.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 upLiftFuel: type: integer description: "Represents the amount of fuel uplifted to the aircraft/equipment.\n\ \ " format: int32 maximum: 2147483647.0 minimum: 0.0 upLiftWeight: type: integer description: "Represents the uplift weight.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 cockpitCrewCount: type: integer description: "Represents the number of crew in the cockpit.\n \ \ " maximum: 32767.0 minimum: 0.0 cabinCrewCount: type: integer description: "Represents the number of crew in the cabin.\n " maximum: 32767.0 minimum: 0.0 TripOperationDelay: type: object description: "Represents the trip operation delay data.\n " additionalProperties: false required: - delayCode - note properties: delayCode: type: string description: "The delay code.\n " maxLength: 4 minLength: 1 delayMinutes: 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 " maxLength: 128 minLength: 1 includeMvtMessage: type: boolean description: "The flag to include the MVT message.\n " tripOperationDelayKey: type: string description: "The unique identification for the trip operation delay.\n\ \ " nullable: true createdDate: type: string description: "The date the delay was created in UTC.\n " format: date-time nullable: true modifiedDate: type: string description: "The date the delay was modified in UTC.\n " format: date-time nullable: true createdUserKey: type: string description: "The unique identifier of the user who created the delay.\n\ \ " nullable: true modifiedUserKey: type: string description: "The unique identifier of the user who modified the delay.\n\ \ " nullable: true TripOperationPayload: type: object description: "Represents the payload data for the trip operation.\n \ \ " additionalProperties: false properties: payloadType: 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 payloadCount: type: integer description: "The payload count.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 weight: type: integer description: "The total payload weight.\n " format: int32 maximum: 2147483647.0 minimum: 1.0 TripOperationCrew: type: object description: "Represents the crew of an trip operation.\n " additionalProperties: false properties: tripOperationCrewKey: type: string description: "The unique identifier for the trip crew operation.\n \ \ " nullable: true crewType: 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 TripOperationComment: type: object description: "Represents a comment for a trip operation.\n " additionalProperties: false properties: text: type: string description: "Represents the comment text.\n " maxLength: 800 minLength: 1 nullable: true type: description: "Represents the comment type.\n " $ref: '#/components/schemas/OperationCommentType' tripOperationCommentKey: type: string description: "The unique identification number for the comment.\n \ \ " nullable: true createdDate: type: string description: "The date the comment was created in UTC.\n " format: date-time nullable: true modifiedDate: type: string description: "The date the comment was modified in UTC.\n " format: date-time nullable: true createdUserKey: type: string description: "The unique identifier of the user who created the comment.\n\ \ " nullable: true modifiedUserKey: type: string description: "The unique identifier of the user who modified the comment.\n\ \ " nullable: true 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 TripOperationHistory: type: object description: "Represents the history of an trip operation.\n " additionalProperties: false properties: tripOperationHistoryKey: type: string description: "The unique identification for the trip operation history.\n\ \ " nullable: true tripOperationHistoryCode: type: string description: "Represents the code for the event that triggered an entry\ \ into history.\n " maxLength: 2 minLength: 1 nullable: true detail: type: string description: "Represents the history details.\n " maxLength: 6000 minLength: 1 nullable: true createdHistoryDate: type: string description: "The date when this history item was created.\n " format: date-time nullable: true OriginDetails: type: object description: "Represents the origin details model.\n " additionalProperties: false properties: note: type: string description: "Represents additional information about the\ntrip operation\ \ station.\n " maxLength: 128 minLength: 0 nullable: true gate: description: "Represents the gate details.\n " nullable: true $ref: '#/components/schemas/GateInformation' station: type: string description: "The station code.\n " maxLength: 3 minLength: 0 nullable: true status: description: "Represents the departure status.\n " $ref: '#/components/schemas/DepartureStatus' DestinationDetails: type: object description: "Represents the destination details model.\n " additionalProperties: false properties: note: type: string description: "Represents additional information about the\ntrip operation\ \ station.\n " maxLength: 128 minLength: 0 nullable: true gate: description: "Represents the gate details.\n " nullable: true $ref: '#/components/schemas/GateInformation' station: type: string description: "The station code.\n " maxLength: 3 minLength: 0 nullable: true status: description: "Represents the arrival status.\n " $ref: '#/components/schemas/ArrivalStatus' baggageClaim: type: string description: "Represents the airline defined location where the trip's\n\ luggage is to be retrieved.\n " maxLength: 10 minLength: 0 nullable: true FlightCloseRequest: type: object description: "Options for flight close\n " additionalProperties: false properties: bypassCheckinRestrictions: type: boolean description: "This will allows updates regardless of checkin configuration\ \ period of time set in settings.\n " overrideBalanceDueWarning: type: boolean description: "This will allow the flight to be closed regardless of any\ \ balance due by any passenger(s) on the leg.\n " overrideExitRowRequirement: type: boolean description: "This will allow the flight to be closed regardless of exit\ \ row requirements.\n " autoBoardAllCheckedInPassengers: type: boolean description: "Board all checked-in passengers automatically. With this Autoboard\ \ feature enabled,\nagents can close a flight before boarding passengers.\n\ \ " convertHoldToConfirmed: type: boolean description: "On Flight Close convert hold to confirmed (HL to HK), Otherwise\ \ set to N.\n " deleteStandByPassengers: type: boolean description: "Also delete standby passengers when converting hold to confirmed.\n\ \ " validateOverWingExitRows: type: boolean description: "Determines whether we will validate the overwing exit row\ \ requirements at flight close.\n " processStandbyPayments: type: boolean description: "Process standby passenger form of payment on flight close.\n\ \ " TripOperationCommentCreateRequest: type: object description: "Represents the create request for a comment for a trip operation.\n\ \ " additionalProperties: false required: - text properties: text: type: string description: "The note for this delay, containing extra information about\ \ the delay\n(if any).\n " maxLength: 800 minLength: 1 type: description: "Represents the comment type.\n " nullable: true $ref: '#/components/schemas/OperationCommentType' TripOperationCommentEditRequest: type: object description: "Represents a comment for a trip operation.\n " additionalProperties: false required: - text properties: text: type: string description: "The note for this delay, containing extra information about\ \ the delay\n(if any).\n " maxLength: 800 minLength: 1 TripOperationDelayCreateRequest: type: object description: "Represents a delay for a trip operation.\n " additionalProperties: false required: - note - delayCode properties: delayMinutes: 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 " maxLength: 128 minLength: 1 includeMvtMessage: type: boolean description: "The flag to include the MVT message.\n " delayCode: type: string description: "The delay code.\n " maxLength: 4 minLength: 1 DeltaMapperOfTripOperationDelayEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: delayMinutes: 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 " maxLength: 128 minLength: 1 includeMvtMessage: type: boolean description: "The flag to include the MVT message.\n " TripOperationDelayEditRequest: type: object description: "Represents a delay for a trip operation.\n " additionalProperties: false required: - note properties: delayMinutes: 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 " maxLength: 128 minLength: 1 includeMvtMessage: type: boolean description: "The flag to include the MVT message.\n " IJsonResponseOfIListOfTripInformationResponsev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/TripInformationResponsev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TripInformationResponsev2: type: object description: "A collection of journeys for a given departure date and market.\n\ \ " additionalProperties: false properties: date: type: string description: "Represents the date for the journey response.\n \ \ " format: date-time nullable: true journeys: type: array description: "Represents the collection of journeys.\n " nullable: true items: $ref: '#/components/schemas/TripInformationJourneyv2' TripInformationJourneyv2: type: object description: "Represents the trip information journey.\n " additionalProperties: false properties: designator: description: "This is a summary of all the segments on the journey. It will\ \ contain the details\nof the transportation from the first and last segment.\n\ \ " nullable: true $ref: '#/components/schemas/TransportationDesignator' tripKey: type: string description: "Represents the trip key.\n " nullable: true segments: type: array description: "Represents the collection of itinerary segments for this journey.\n\ \ " nullable: true items: $ref: '#/components/schemas/ItinerarySegment' ItinerarySegment: type: object description: "Represents the operation between board station and any subsequent\ \ off station\nwithin the same flight.\n " additionalProperties: false properties: isSeatmapViewable: type: boolean description: "Indicates if the seatmaps associated with the segment are\ \ retrievable.\nSets to `false` for passive segments, and `true` for non-passive\ \ segments.\n " identifier: description: "The transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' externalIdentifier: description: "The external transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' segmentType: description: "The type of the segment.\n " $ref: '#/components/schemas/SegmentTypes' designator: description: "This is a summary of all the legs on the segment. It will\ \ contain the details\nof the transportation from the first and last leg.\n\ \ " nullable: true $ref: '#/components/schemas/TransportationDesignator' segmentKey: type: string description: "The unique identifier for the segment.\n " nullable: true legs: type: array description: "The legs.\n " nullable: true items: $ref: '#/components/schemas/ItineraryLeg' ItineraryLeg: type: object description: "Defines a single instance of non-stop travel between two stations.\n\ \ " additionalProperties: false properties: legKey: type: string description: "The unique identifier for this leg sell information.\n \ \ " nullable: true designator: description: "Transportation information.\n " nullable: true $ref: '#/components/schemas/TransportationDesignator' TripInformationQuery: type: object description: "The trip information query model contains data to perform a\n\ trip information search.\n " additionalProperties: false required: - beginDate properties: endDate: type: string description: "The end date of the trip information search.\n " format: date-time nullable: true startTimeInterval: type: string description: "The starting time of the trip information search.\n \ \ " format: duration nullable: true endTimeInterval: type: string description: "The end time of the trip information search.\n " format: duration nullable: true carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 nullable: true beginDate: type: string description: "The starting date of the trip information search.\n \ \ " format: date-time minLength: 1 identifier: type: string description: "The transportation identifier, such as a flight number.\n\ \ " maxLength: 4 minLength: 0 nullable: true flightType: description: "The flight type.\n " nullable: true $ref: '#/components/schemas/OperationsFlightType' daysOfWeek: type: array description: "The days of the week to include in the provided date range.\n\ \ " nullable: true items: $ref: '#/components/schemas/DayOfWeek' equipmentFilter: description: "The optional equipment filter for the search.\n \ \ " nullable: true $ref: '#/components/schemas/EquipmentFilter' originStations: type: array description: "The list of departure stations.\n " nullable: true items: type: string destinationStations: type: array description: "The list of arrival stations.\n " nullable: true items: type: string opSuffix: type: string description: "The operational suffix.\nPlease note that this should be a\ \ char and not a string.\n " maxLength: 1 nullable: true searchXRef: type: boolean description: "Indicates whether to include marketing code share segments.\n\ Setting this flag to true will request all marketing code share segments\n\ in addition to the operational ones.\n " excludeMarketedFlights: type: boolean description: "When set to true, all flights with a non-blank operating carrier\ \ are filtered out of the result.\nThe DB calls the parameter noOperatingCarrier.\n\ \ " numberOfJourneys: type: integer description: "When set to null, 100 journeys will be returned.\nThis endpoint\ \ will never return more than 100 journeys.\n " format: int32 nullable: true OperationsFlightType: type: integer description: "Flight types enumeration for operations and schedules.\n \ \ \n\n0 = All\n1 = NonStop\n2 = Through\n3 = Direct\n4 = Connect" x-enumNames: - All - NonStop - Through - Direct - Connect enum: - 0 - 1 - 2 - 3 - 4 ApisQueueRequest: type: object description: "Request object for SendAPIS transaction. Matches to the SendAPISRequest\ \ object in NSK.\n " additionalProperties: false properties: apisRequestType: description: "Used to specify what type of APIS request this is.\nDefault\ \ is APISRequestType.APISRequest.\n " $ref: '#/components/schemas/ApisRequestType' contactPhone: type: string description: "Gets or Sets ContactPhone property.\n " nullable: true faxNumber: type: string description: "Gets or Sets FaxNumber property.\n " nullable: true targetCountry: type: string description: "Only send APIS or CLOB to this CountryCode message targets.\n\ \ " nullable: true contactName: description: "Gets or Sets ContactName property.\n " nullable: true $ref: '#/components/schemas/Name' marketInformation: description: "Contains the MarketInformation that identifies a flight.\n\ \ " nullable: true $ref: '#/components/schemas/MarketInformation' ApisRequestType: type: integer description: "The APIS Message Request Types. Determines which message is queued.\n\ \ \n\n0 = APISRequest\n1 = APISPreRequest\n2 = APISWithFlightVerify\n\ 3 = EUBPreRequest\n4 = EUBCloseRequest\n5 = UNAPISPreRequest\n6 = FlightClose\n\ 7 = ClosePending" x-enumNames: - APISRequest - APISPreRequest - APISWithFlightVerify - EUBPreRequest - EUBCloseRequest - UNAPISPreRequest - FlightClose - ClosePending enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 IJsonResponseOfIListOfPassengerSeatAssignment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerSeatAssignment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerSeatAssignment: type: object description: "The passenger seat assignment model.\n " additionalProperties: false properties: recordLocator: type: string description: "The record locator.\n " nullable: true name: description: "The passenger name.\n " nullable: true $ref: '#/components/schemas/Name' infantTicketNumber: type: string description: "The ticket number of the infant with the passenger.\n \ \ " nullable: true ticketNumber: type: string description: "The ticket number of the passenger.\n " nullable: true ticketIndicator: type: string description: "The ticket type of the passenger.\n " nullable: true ssrCodes: type: array description: "The list of SSR codes associated with this passenger.\n \ \ " nullable: true items: type: string passengerNumber: type: integer description: "The passenger number.\n " passengerType: type: string description: "The passenger type.\n " nullable: true example: "ADT - Adult, CHD - Child, SNR - Senior, Mil - Military\n \ \ " classOfService: type: string description: "The class of service.\n " nullable: true unitDesignator: type: string description: "The unit designator.\n " nullable: true liftStatus: description: "The status of the flight leg. It indicates whether the coupon\ \ has been used, and\nif the passenger has been checked in, has boarded\ \ the flight or not.\n " $ref: '#/components/schemas/LiftStatus' baggageCount: type: integer description: "The number of bags associated with the passenger.\n \ \ " maximum: 99.0 minimum: 0.0 IJsonResponseOfManifestLight: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ManifestLight' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ManifestLight: type: object description: "The flight manifest model. This version is built to be lighter\ \ and more performance for API clients.\n " additionalProperties: false properties: passengers: type: array description: "Gets collection of manifest passenger version two.\n \ \ " nullable: true items: $ref: '#/components/schemas/ManifestLightPassenger' cabinPassengerCounts: type: array description: "The collection of manifest cabin passenger counts.\n \ \ " nullable: true items: $ref: '#/components/schemas/ManifestCabinPassengerCount' inventoryLegCrossReferences: type: array description: "Collection of inventory leg cross reference objects.\n \ \ " nullable: true items: $ref: '#/components/schemas/LegCrossReference' passengerCounts: description: "Represents passenger count data associated with the\nmanifest\ \ object.\n " nullable: true $ref: '#/components/schemas/PassengerCounts' checkInLid: type: integer description: "The check-in lid in the manifest object.\n " maximum: 32767.0 minimum: 0.0 codeShareIndicator: type: string description: "The indicator on whether the leg/flight is a code-share flight.\n\ Please note that this should be a char and not a string.\n " maxLength: 1 nullable: true operatedByText: type: string description: "The operated by text.\n " nullable: true operatingIdentifier: description: "The operating transportation information, such as carrier\ \ code,\nflight number/identifier, etc.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' legStatus: description: "The Inventory Leg Status of this Manifest Leg.\n \ \ " $ref: '#/components/schemas/LegStatus' ManifestLightPassenger: type: object description: "The manifest passenger used for lighter endpoints without nested\ \ duplicated data.\n " additionalProperties: false properties: balanceDue: type: boolean description: "If there is a balance due it returns true. This is the same\ \ as having an under paid, paid status.\n " userKey: type: string description: "The user key.\n " nullable: true personKey: type: string description: "The unique person key\n " nullable: true passengerAlternateKey: type: string description: "The passenger's alternate key\n " nullable: true passengerKey: type: string description: "The unique identifier for the passenger.\n " nullable: true checkInType: description: "The type of flight that is being dealt with: Local = first\ \ leg of journey\n " $ref: '#/components/schemas/CheckInType' customerNumber: type: string description: "The string that represents the customer number of the person.\n\ \ " maxLength: 20 minLength: 0 nullable: true discountCode: type: string description: "The discount code used by the passenger in booking this reservation.\n\ \ " maxLength: 8 minLength: 0 nullable: true infant: description: "The information about the infant traveling with the passenger.\n\ \ " nullable: true $ref: '#/components/schemas/Infant' name: description: "Passenger's Name.\n " nullable: true $ref: '#/components/schemas/Name' paidStatus: description: "The PaidStatus property.\n " $ref: '#/components/schemas/PaidStatus' profileStatus: description: "The ProfileStatus property.\n " $ref: '#/components/schemas/BookingProfileStatus' program: description: "The passenger program data.\n " nullable: true $ref: '#/components/schemas/Program' recordLocator: type: string description: "The record locator for the booking.\n " maxLength: 12 minLength: 0 nullable: true sourcePointOfSale: description: "The balance due on the passenger.\n " nullable: true $ref: '#/components/schemas/PointOfSale' bookingStatus: description: "The booking status.\n " $ref: '#/components/schemas/BookingStatus' passengerInformation: description: "Additional passenger information details.\n " nullable: true $ref: '#/components/schemas/PassengerInformation' type: type: string description: "The passenger's type.\n " nullable: true bookingDate: type: string description: "The date the booking was created.\n " format: date-time nullable: true soldDate: type: string description: "The date the segment was created.\n " format: date-time nullable: true journey: description: "Journey details of the passenger.\n " nullable: true $ref: '#/components/schemas/ManifestPassengerJourney' CheckInType: type: integer description: "Check in Types enumeration.\n \n\n0 = Default\n1 =\ \ Local\n2 = Through\n4 = Connecting\n6 = NonLocal" x-enumNames: - Default - Local - Through - Connecting - NonLocal enum: - 0 - 1 - 2 - 4 - 6 Program: type: object description: "Model representing a passenger program.\n " additionalProperties: false properties: code: type: string description: "The program code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ nullable: true levelCode: type: string description: "The program level code.\n " maxLength: 3 minLength: 0 pattern: ^[^|]*$ nullable: true number: type: string description: "The program number.\n " maxLength: 32 minLength: 0 nullable: true ManifestPassengerJourney: type: object description: "The manifest passenger journey used for lighter endpoints without\ \ nested duplicated data.\n " additionalProperties: false properties: customerRecognition: description: "The customer recognition details.\n " nullable: true $ref: '#/components/schemas/ManifestCustomerRecognition' segmentCount: type: integer description: "The number of segments for this passenger.\n " format: int32 segment: description: "The segment details.\n " nullable: true $ref: '#/components/schemas/ManifestLightSegment' changeReason: description: "The journey change reason.\n " $ref: '#/components/schemas/ChangeReasonCodes' ManifestCustomerRecognition: type: object description: "The manifest loyalty used for lighter endpoints without nested\ \ duplicated data.\n " additionalProperties: false properties: code: type: string description: "The customer recognition code that aligns with the recognition\ \ level.\n " maxLength: 1 nullable: true points: type: integer description: "The customer recognition score in points.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 ManifestLightSegment: type: object description: "The manifest segment data.\n " additionalProperties: false properties: bookingStatus: type: string description: "The BookingStatus property.\n " nullable: true changeReason: description: "The ChangeReasonCode property.\n " $ref: '#/components/schemas/ChangeReasonCodes' classOfService: type: string description: "The ClassOfService property.\n " nullable: true fareBasisCode: type: string description: "The FareBasisCode.\n " nullable: true leg: description: "The Leg property.\n " nullable: true $ref: '#/components/schemas/ManifestLightLeg' productClassCode: type: string description: "The product class code.\n " nullable: true seatProperties: type: array description: "The Legs property.\n " nullable: true items: $ref: '#/components/schemas/ManifestSeatProperty' soldDate: type: string description: "The date the segment was sold.\n " format: date-time nullable: true ticketIndicator: type: string description: "The ticket indicator.\n " nullable: true ticketNumber: type: string description: "The ticket number.\n " nullable: true upgradeIndicator: type: boolean description: "The upgrade indicator property.\n " externalIdentifier: description: "The travel cross reference 'xref' identifier information.\n\ \ " nullable: true $ref: '#/components/schemas/TransportationIdentifier' legCount: type: integer description: "The number of legs on the segment.\n " format: int32 segmentType: description: "The manifest segment type.\n " $ref: '#/components/schemas/SegmentTypes' manifestSegmentKey: type: string description: "The manifest segment key.\n " nullable: true ticketFareBasis: type: string description: "A fare basis alias which is a more descriptive and custom\ \ value than the fare basis itself.\nThis value is created in FareManager\ \ Plus based on specific fare rule categories and ATPCO documentation.\n\ \ " nullable: true ManifestLightLeg: type: object description: "The manifest leg data.\n " additionalProperties: false properties: boardingSequence: type: integer description: "The boarding sequence property.\n " maximum: 32767.0 minimum: 0.0 boardingZone: type: integer description: "Boarding Zone of ManifestLeg.\n " maximum: 99.0 minimum: 0.0 compartmentDesignator: type: string description: "The CompartmentDesignator property.\n " nullable: true legNumber: type: integer description: "The LegNumber property.\n " maximum: 32767.0 minimum: 0.0 liftStatus: description: "The LiftStatus property.\n " $ref: '#/components/schemas/LiftStatus' priorityCode: type: string description: "The PriorityCode property.\n " nullable: true priorityDate: type: string description: "The PriorityDate property.\n " format: date-time nullable: true unitAssignmentWeight: type: integer description: "The unit assignment weight. This value is used to determine\n\ the satisfaction level of the passenger's seat assignment.\n \ \ " format: int32 unitDesignator: type: string description: "The UnitDesignator property.\n " nullable: true manifestLegKey: type: string description: "The manifest leg key.\n " nullable: true ManifestSeatProperty: type: object description: "Manifest Seat Property.\n " additionalProperties: false properties: preferenceStatus: type: string description: "The preference status field contains the current met/unmet\ \ or unknown status.\n " nullable: true propertyCode: type: string description: "The property code is a string value. The expected value is\ \ true.\n " nullable: true propertyTypeCode: type: string description: "The property type code indicates the type of seat preference\ \ requested.\n " nullable: true ManifestCabinPassengerCount: type: object description: "Manifest Cabin Passenger Count.\n " additionalProperties: false properties: checkedIn: type: integer description: "The checked-in passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 clearedStandBy: type: integer description: "The cleared standby passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 clearedThruStandby: type: integer description: "The cleared thru standby passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 manifested: type: integer description: "The manifested passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 noShow: type: integer description: "The passenger \"no-show\" count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 standBy: type: integer description: "The standby passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 thruCheckedIn: type: integer description: "The thru checked-in passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 thruManifested: type: integer description: "The thru manifested passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 thruNoShow: type: integer description: "The thru \"no-show\" passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 thruStandBy: type: integer description: "The thru standby passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 totalCheckedIn: type: integer description: "The total checked-in passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 totalOnBoard: type: integer description: "The total on-board passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 classRank: type: integer description: "The cabin class rank.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 cabinOfService: type: string description: "The cabin of service.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 nullable: true PassengerCounts: type: object description: "Represents various count data for passengers, such as checked-in,\ \ no-shows, etc.\n " additionalProperties: false properties: checkedIn: type: integer description: "The checked-in passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 clearedStandBy: type: integer description: "The cleared standby passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 clearedThruStandby: type: integer description: "The cleared thru standby passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 manifested: type: integer description: "The manifested passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 noShow: type: integer description: "The passenger \"no-show\" count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 standBy: type: integer description: "The standby passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 thruCheckedIn: type: integer description: "The thru checked-in passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 thruManifested: type: integer description: "The thru manifested passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 thruNoShow: type: integer description: "The thru \"no-show\" passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 thruStandBy: type: integer description: "The thru standby passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 totalCheckedIn: type: integer description: "The total checked-in passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 totalOnBoard: type: integer description: "The total on-board passenger count.\n " format: int32 maximum: 2147483647.0 minimum: 0.0 IJsonResponseOfIListOfManifestSsr: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ManifestSsr' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ManifestSsr: type: object description: "The flight manifest ssr data.\n " additionalProperties: false properties: note: type: string description: "The additional information on the SSR that are not visible\ \ to passengers.\n " nullable: true ssrCode: type: string description: "The unique code to identify an SSR.\n " nullable: true ssrDetail: type: string description: "The additional information for the SSR as requested by the\ \ passenger.\n " nullable: true passengerAlternateKey: type: string description: "Unique passenger key\n " nullable: true legNumber: type: integer description: "The leg number if this is a leg ssr.\n " format: int32 nullable: true isOrigin: type: boolean description: "Is on the same leg as the manifest you are viewing.\n \ \ " recordLocator: type: string description: "The associated booking record locator.\n " nullable: true IJsonResponseOfIDictionaryOfStringAndManifestBookings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: $ref: '#/components/schemas/ManifestBookings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ManifestBookings: type: object description: "The manifest booking.\n " additionalProperties: false properties: recordLocator: type: string description: "The associated booking record locator.\n " nullable: true created: type: string description: "The created date.\n " format: date-time paidStatus: description: "The paid status.\n " $ref: '#/components/schemas/PaidStatus' status: description: "The booking status.\n " $ref: '#/components/schemas/BookingStatus' passengersOnBooking: type: integer description: "The total number of passengers on the booking.\n \ \ " format: int32 queues: type: array description: "The subset of locking or warning related queues on the booking.\n\ \ " nullable: true items: $ref: '#/components/schemas/ManifestQueue' comments: type: array description: "The booking comments.\n " nullable: true items: $ref: '#/components/schemas/ManifestLightComment' bookingId: type: integer description: "The booking id.\n " format: int64 ManifestQueue: type: object description: "Manifest Queue.\n " additionalProperties: false properties: manifestQueueKey: type: string description: "Represents the unique identifier for the manifest queue model.\n\ \ " nullable: true queueAction: description: "The action that will be taken as a result of the placement\ \ in.\n " $ref: '#/components/schemas/QueueAction' queueCategoryCode: type: string description: "The QueueCategoryCode property.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 nullable: true queueCode: type: string description: "The identifier for the queue where the booking is placed.\n\ \ " maxLength: 6 minLength: 0 nullable: true queueName: type: string description: "The name for the queue where the booking is placed.\n \ \ " maxLength: 64 minLength: 0 nullable: true ManifestLightComment: type: object description: "The manifest comment.\n " additionalProperties: false properties: userKey: type: string description: "The unique user key.\n " nullable: true date: type: string description: "The comment date.\n " format: date-time nullable: true comment: type: string description: "The comment text.\n " nullable: true commentType: description: "The comment type.\n " $ref: '#/components/schemas/CommentType' domainCode: type: string description: "The domain code.\n " nullable: true organizationCode: type: string description: "The organization code.\n " nullable: true systemName: description: "The system name.\n " $ref: '#/components/schemas/SystemName' IJsonResponseOfIDictionaryOfStringAndIDictionaryOfStringAndIListOfOperationBag: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: type: object additionalProperties: type: array items: $ref: '#/components/schemas/OperationBag' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' WeightType2: type: integer description: '0 = Default 1 = Pounds 2 = Kilograms' x-enumNames: - Default - Pounds - Kilograms enum: - 0 - 1 - 2 IJsonResponseOfIListOfManifestBySegment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ManifestBySegment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ManifestBySegment: type: object description: "The manifest data sorted by segment then passenger used for lighter\ \ endpoints without nested duplicated data.\n " additionalProperties: false properties: market: description: "The segments market.\n " nullable: true $ref: '#/components/schemas/MarketInformation' externalIdentifier: description: "The external 'xref' identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' legs: type: array description: "The leg details.\n " nullable: true items: $ref: '#/components/schemas/ManifestLegMarket' passengers: type: array description: "The passenger specific details.\n " nullable: true items: $ref: '#/components/schemas/ManifestPassengerSegment' manifestSegmentKey: type: string description: "The manifest segment key.\n " nullable: true ManifestLegMarket: type: object description: "The manifest leg market used for lighter endpoints without nested\ \ duplicated data.\n " additionalProperties: false properties: legNumber: type: integer description: "The leg number associated with the segment\n " format: int32 market: description: "The segment's market.\n " nullable: true $ref: '#/components/schemas/MarketInformation' liftStatus: description: "The lift status.\n " deprecated: true x-deprecatedMessage: Lift status at this level is incorrect. Use the lift status on the ManifestLegPassenger model instead. This property will be removed in a future release. $ref: '#/components/schemas/LiftStatus' manifestOrigin: type: boolean description: "Returns true if this is the same leg as requested in the manifest.\n\ \ " manifestLegKey: type: string description: "The manifest leg key.\n " nullable: true ManifestPassengerSegment: type: object description: "The manifest data related unique to the passenger on the segment.\n\ \ " additionalProperties: false properties: passengerAlternateKey: type: string description: "Unique passenger key.\n " nullable: true baggageAllowanceUsed: type: boolean description: "Baggage Allowance Used.\n " baggageAllowanceWeight: type: integer description: "Baggage Allowance Weight.\n " maximum: 32767.0 minimum: 0.0 baggageAllowanceWeightType: description: "Weight Type.\n " $ref: '#/components/schemas/WeightType' cabinOfService: type: string description: "The CabinOfService property.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 nullable: true changeReasonCode: type: string description: "The ChangeReasonCode property.\n " nullable: true classOfService: type: string description: "The ClassOfService property.\n " nullable: true fareBasisCode: type: string description: "The FareBasisCode.\n " nullable: true productClassCode: type: string description: "The product class code.\n " nullable: true seatProperties: type: array description: "The Legs property.\n " nullable: true items: $ref: '#/components/schemas/ManifestSeatProperty' ticketIndicator: type: string description: "The ticket indicator.\n " nullable: true ticketNumber: type: string description: "The ticket number.\n " nullable: true upgradeIndicator: type: boolean description: "The upgrade indicator property.\n " verifiedTravelDocs: type: string description: "The VerifiedTravelDocs property.\n " nullable: true legs: type: array description: "The passenger related leg details.\n " nullable: true items: $ref: '#/components/schemas/ManifestLegPassenger' passengerSegmentOrderNumber: type: integer description: "The order of the segment on the passenger's booking.\n \ \ " format: int32 ticketFareBasis: type: string description: "A fare basis alias which is a more descriptive and custom\ \ value than the fare basis itself.\nThis value is created in FareManager\ \ Plus based on specific fare rule categories and ATPCO documentation.\n\ \ " nullable: true ManifestLegPassenger: type: object description: "The manifest data related to the passenger and leg.\n \ \ " additionalProperties: false properties: boardingSequence: type: integer description: "The BoardingSequence property.\n " maximum: 32767.0 minimum: 0.0 boardingZone: type: integer description: "Boarding Zone of ManifestLeg.\n " maximum: 99.0 minimum: 0.0 compartmentDesignator: type: string description: "The CompartmentDesignator property.\n " nullable: true priorityCode: type: string description: "The PriorityCode property.\n " nullable: true priorityDate: type: string description: "The PriorityDate property.\n " format: date-time nullable: true promptToVerifyId: type: boolean description: "Indicates whether to prompt to verify the passenger id when\ \ checking in.\n " unitAssignmentWeight: type: integer description: "The unit assignment weight. This value is used to determine\n\ the satisfaction level of the passenger's seat assignment.\n \ \ " format: int32 unitDesignator: type: string description: "The UnitDesignator property.\n " nullable: true manifestUnitKey: type: string description: "The ManifestUnitKey property.\n " nullable: true liftStatus: description: "The lift status.\n " $ref: '#/components/schemas/LiftStatus' IJsonResponseOfIDictionaryOfStringAndListOfManifestLightPassengerGovernmentSecurityInfo: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: object description: "The payload data.\n " nullable: true additionalProperties: type: array items: $ref: '#/components/schemas/ManifestLightPassengerGovernmentSecurityInfo' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ManifestLightPassengerGovernmentSecurityInfo: type: object description: "The manifest passenger government security info with infant.\n\ \ " additionalProperties: false properties: userKey: type: string description: "The user key.\n " nullable: true personKey: type: string description: "The unique person key\n " nullable: true passengerAlternateKey: type: string description: "The passenger's alternate key\n " nullable: true passengerKey: type: string description: "The unique identifier for the passenger.\n " nullable: true checkInType: description: "The type of flight that is being dealt with: Local = first\ \ leg of journey\n " $ref: '#/components/schemas/CheckInType' infant: description: "The information about the infant traveling with the passenger.\n\ \ " nullable: true $ref: '#/components/schemas/Infant' name: description: "Passenger's Name.\n " nullable: true $ref: '#/components/schemas/Name' recordLocator: type: string description: "The record locator for the booking.\n " maxLength: 12 minLength: 0 nullable: true bookingStatus: description: "The booking status.\n " $ref: '#/components/schemas/BookingStatus' passengerInformation: description: "Additional passenger information details.\n " nullable: true $ref: '#/components/schemas/PassengerInformation' type: type: string description: "The passenger's type.\n " nullable: true bookingDate: type: string description: "The date the booking was created.\n " format: date-time nullable: true isMissingVerifiedDocAdult: type: boolean description: "Bool of if the passenger has a verified doc or not.\n \ \ " isMissingVerifiedDocInfant: type: boolean description: "Bool of if the passenger infant has a verified doc or not.\n\ \ " passengerAddresses: type: array description: "List of passengers addresses.\n " nullable: true items: $ref: '#/components/schemas/ManifestPassengerAddressv2' passengerTravelDocuments: type: array description: "List of passengers travel documents.\n " nullable: true items: $ref: '#/components/schemas/PassengerTravelDocument' passengerAddressRequirement: type: boolean description: "Bool of if the passenger requires an address.\n \ \ " profileStatus: description: "Profile security status of the passenger\n " $ref: '#/components/schemas/BookingProfileStatus' authorizationList: type: array description: "List of government security requirements\n " nullable: true items: $ref: '#/components/schemas/SecurityAuthorizationInformation' ManifestPassengerAddressv2: type: object description: "The manifest passenger address version two model.\n \ \ " additionalProperties: false properties: countryName: type: string description: "The name of the country.\n " maxLength: 32 minLength: 0 nullable: true companyName: type: string description: "Company name associated with this address.\n " maxLength: 64 minLength: 0 nullable: true phone: type: string description: "Phone number associated with this address.\n " maxLength: 20 minLength: 0 nullable: true stationCode: type: string description: "Station code associated with this address.\n " maxLength: 3 minLength: 3 nullable: true emailAddress: type: string description: "The email address associated with the address.\n \ \ " nullable: true status: description: "The addresses APIS status.\n " $ref: '#/components/schemas/ApisAddressStatus' passengerAddressKey: type: string description: "The unique address identifier.\n " nullable: true lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true passengerAlternateKey: type: string description: "The passenger's alternate key.\n " nullable: true IJsonResponseOfManifestLightGovernmentSecurityInfoResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ManifestLightGovernmentSecurityInfoResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ManifestLightGovernmentSecurityInfoResponse: type: object description: "The manifest government security info response.\n " additionalProperties: false properties: passengers: type: array description: "The list of passenger government security information.\n \ \ " nullable: true items: $ref: '#/components/schemas/ManifestLightPassengerGovernmentSecurityInfo' arrivalCountry: description: "Information about the destination country regarding APIS and\ \ APPS.\nThis is only populated for international flights.\n \ \ " nullable: true $ref: '#/components/schemas/CountryBase' departureCountry: description: "Information about the country of origin regarding APIS and\ \ APPS.\nThis is only populated for international flights.\n \ \ " nullable: true $ref: '#/components/schemas/CountryBase' internationalFlight: type: boolean description: "Determines if the flight is international or domestic.\n \ \ " CountryBase: type: object description: "Represents the base class for a country model.\n " additionalProperties: false required: - countryCode - countryCode3C properties: apisCheckDocuments: type: boolean description: "Are we required to check APIS documents.\n " apisRequiredInbound: type: boolean description: "Defines whether or not this Arrival Station requires APIS.\n\ \ " apisRequiredOutbound: type: boolean description: "Defines whether or not this departure station requires APIS.\n\ \ " appsRequiredInbound: type: boolean description: "Defines whether or not this arrival station requires APPS.\n\ \ " appsRequiredOutbound: type: boolean description: "Defines whether or not this departure station requires APPS.\n\ \ " countryCode: type: string description: "Represents the two-digit country code.\n " maxLength: 2 minLength: 1 countryCode3C: type: string description: "Represents the three-digit country code.\n " maxLength: 3 minLength: 1 IJsonResponseOfPassengerDetailsv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerDetailsv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerDetailsv2: type: object description: "The passenger details version two model.\n " additionalProperties: false properties: summary: description: "The manifest passenger details summary.\n " nullable: true $ref: '#/components/schemas/PassengerDetailsSummary' passengers: type: array description: "The list of passenger detail information.\n " nullable: true items: $ref: '#/components/schemas/PassengerDetailv2' PassengerDetailsSummary: type: object description: "The manifest passenger details summary.\n " additionalProperties: false properties: totalConfirmedMales: type: integer description: "The total number of confirmed male passengers.\n \ \ " format: int32 totalConfirmedFemales: type: integer description: "The total number of confirmed female passengers.\n \ \ " format: int32 totalConfirmedChildren: type: integer description: "The total number of confirmed children.\n " format: int32 totalConfirmedInfants: type: integer description: "The total number of confirmed infants.\n " format: int32 totalWaitListConfirmedMales: type: integer description: "The total number of wait list confirmed male passengers.\n\ \ " format: int32 totalWaitListConfirmedFemales: type: integer description: "The total number of wait list confirmed female passengers.\n\ \ " format: int32 totalWaitListConfirmedChildren: type: integer description: "The total number of wait list confirmed children.\n \ \ " format: int32 totalWaitListConfirmedInfants: type: integer description: "The total number of wait list confirmed infants.\n \ \ " format: int32 totalUnconfirmedMales: type: integer description: "The total number of unconfirmed male passengers.\n \ \ " format: int32 totalUnconfirmedFemales: type: integer description: "The total number of unconfirmed female passengers.\n \ \ " format: int32 totalUnconfirmedChildren: type: integer description: "The total number of unconfirmed children.\n " format: int32 totalUnconfirmedInfants: type: integer description: "The total number of unconfirmed infants.\n " format: int32 PassengerDetailv2: type: object description: "The passenger detail version two model.\n " additionalProperties: false properties: status: description: "The current status of the booking.\n " $ref: '#/components/schemas/BookingStatus' createdDate: type: string description: "The initial date and time of the booking.\n " format: date-time nullable: true profileStatus: description: "The profile status on the booking.\n " $ref: '#/components/schemas/BookingProfileStatus' weightCategory: description: "The weight category assigned to this passenger.\n \ \ " $ref: '#/components/schemas/WeightCategory' origin: type: string description: "The departure station code.\n " nullable: true destination: type: string description: "The arrival station code.\n " nullable: true tripType: description: "The current assigned trip type.\n " $ref: '#/components/schemas/TripType' segmentBookingStatus: type: string description: "The passenger segment booking status.\n " nullable: true connectingFlight: type: string description: "The connecting flight number if appropriate.\n " nullable: true connectingStation: type: string description: "The connecting station code if appropriate.\n " nullable: true finalDestination: type: string description: "The final destination station code.\n " nullable: true paymentMethods: type: array description: "The list of payment codes for the booking.\n " nullable: true items: type: string comments: type: array description: "The list of the manifest comments.\n " nullable: true items: type: string infant: description: "The infant associated with the passenger.\n " nullable: true $ref: '#/components/schemas/InfantBase' customerProgram: description: "The customer program associated with the passenger.\n \ \ " nullable: true $ref: '#/components/schemas/Program' verifiedReference: type: string description: "The reference of who or what verified the passenger's documents.\n\ \ " nullable: true guestValueLevel: type: string description: "The passenger guest value level.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 nullable: true paidStatus: description: "The paid status for the passenger.\n " $ref: '#/components/schemas/PaidStatus' recordLocator: type: string description: "The record locator.\n " nullable: true name: description: "The passenger name.\n " nullable: true $ref: '#/components/schemas/Name' infantTicketNumber: type: string description: "The ticket number of the infant with the passenger.\n \ \ " nullable: true ticketNumber: type: string description: "The ticket number of the passenger.\n " nullable: true ticketIndicator: type: string description: "The ticket type of the passenger.\n " nullable: true ssrCodes: type: array description: "The list of SSR codes associated with this passenger.\n \ \ " nullable: true items: type: string passengerAlternateKey: type: string description: "The passenger's alternate key.\n " nullable: true TripType: type: integer description: "The trip type enumeration\n \n\n0 = None\n1 = OneWay\n\ 2 = RoundTrip\n3 = HalfRound\n4 = OpenJaw\n5 = CircleTrip\n6 = All" x-enumNames: - None - OneWay - RoundTrip - HalfRound - OpenJaw - CircleTrip - All enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 InfantBase: type: object description: "The base class for the infant.\n " additionalProperties: false properties: dateOfBirth: type: string description: "The date of birth of the infant.\n " format: date-time nullable: true gender: description: "The gender of the passenger.\n " nullable: true $ref: '#/components/schemas/Gender' name: description: "The name of the passenger.\n " nullable: true $ref: '#/components/schemas/Name' declaredGender: type: string description: "The infant's declared gender. A value of \"F\" is mapped to\ \ a female binary gender. All other values will be\nmapped to a male binary\ \ gender.\n " maxLength: 2 minLength: 0 nullable: true DeleteBookingQueueItemBaseRequest: type: object description: "API request object used to delete a booking queue item.\n \ \ " additionalProperties: false required: - authorizedBy - notes properties: authorizedBy: type: string description: "Information about who authorized the deletion of the booking\ \ queue item.\n " minLength: 1 notes: type: string description: "Notes associated with the deletion of the booking queue item.\n\ \ " minLength: 1 password: type: string description: "The password if needed for the booking queue.\n \ \ " nullable: true IJsonResponseOfIListOfBookingQueueHistory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BookingQueueHistory' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingQueueHistory: type: object description: "Represents a booking queue history item.\n " additionalProperties: false properties: alternatePassengerKey: type: string description: "The alternate passenger key.\n " nullable: true historyId: type: integer description: "The booking queue history ID.\n " format: int64 historyEvent: description: "The booking queue history event type.\n " $ref: '#/components/schemas/BookingQueueHistoryEvent' queueCode: type: string description: "The booking queue code.\n " nullable: true note: type: string description: "The booking queue note.\n " nullable: true dequeueNote: type: string description: "The note associated with a dequeue action.\n " nullable: true authorizedBy: type: string description: "The booking queue authorized by field.\n " nullable: true priorityDate: type: string description: "The booking queue priority date.\n " format: date-time nullable: true queueAction: description: "The booking queue action.\n " $ref: '#/components/schemas/QueueAction' domainCode: type: string description: "The booking queue domain code.\n " nullable: true createdByUserKey: type: string description: "The key of the user that created the booking queue event.\n\ \ " nullable: true createdDate: type: string description: "The booking queue item created date.\n " format: date-time nullable: true queueType: description: "The booking queue item event type.\n " $ref: '#/components/schemas/QueueEventType' pointOfSale: description: "The booking queue item point of sale.\n " nullable: true $ref: '#/components/schemas/PointOfSale' segmentKey: type: string description: "The booking queue item segment key.\n " nullable: true watchListId: type: integer description: "The watch list ID of the booking queue entry.\n \ \ " format: int64 nullable: true BookingQueueHistoryEvent: type: integer description: "The booking queue history code values represent the different\ \ events that trigger\nan entry into the booking queue history.\n \ \ \n\n0 = Unknown\n1 = Add\n2 = Remove\n3 = Update" x-enumNames: - Unknown - Add - Remove - Update enum: - 0 - 1 - 2 - 3 BookingQueueHistoryRequest: type: object description: "The booking queue history request model.\n " additionalProperties: false properties: password: type: string description: "The password needed to access the queue. Required if queue\n\ is set to password-protected in Sky Manager.\n " nullable: true lastPageIndex: type: integer description: "Indicates the last item number in the history list that was\ \ returned.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 1.0 nullable: true pageSize: type: integer description: "Used to specify the number of records to return when paging\ \ is supported.\nThis is optional.\n " maximum: 5000.0 minimum: 10.0 nullable: true fromArchive: type: boolean description: "Gets or sets the from archive flag needed to access the queue.\n\ \ " MoveBookingQueueItemBase: type: object description: "Defines a move booking queue item request\n " additionalProperties: false required: - bookingKey - newQueueCode properties: bookingKey: type: string description: "The existing booking key.\n " minLength: 1 password: type: string description: "The current password if required for the queue.\n \ \ " maxLength: 16 minLength: 0 nullable: true newQueueCode: type: string description: "The new booking queue the item will be moved to.\n \ \ " maxLength: 6 minLength: 0 newQueuePassword: type: string description: "The password if required for the new queue.\n " maxLength: 16 minLength: 0 nullable: true IJsonResponseOfIListOfQueue: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Queue' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Queue: type: object description: "Base class for all queue model objects.\n " additionalProperties: false properties: queueCode: type: string description: "Queue code.\n " nullable: true subQueueCode: type: string description: "Sub-queue code.\n " nullable: true queueCategoryCode: type: string description: "Queue category used by routing logic.\nPlease note that this\ \ should be a char and not a string.\n " maxLength: 1 name: type: string description: "Queue name.\n " nullable: true totalBookings: type: integer description: "The number of bookings on the queue.\n " format: int64 restriction: description: "The booking queue restriction.\n " $ref: '#/components/schemas/BookingQueueRestriction' hasPassword: type: boolean description: "Indicates if the queue has a password.\n " status: description: "Status of the queue.\n " $ref: '#/components/schemas/BookingQueueStatus' BookingQueueStatus: type: integer description: "Defines the status for booking queues.\n \n\n0 = Open\n\ 1 = Locked\n2 = Internal" x-enumNames: - Open - Locked - Internal enum: - 0 - 1 - 2 IJsonResponseOfMessageResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/MessageResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' MessageResponse: type: object description: "The message response.\n " additionalProperties: false properties: typeCode: type: string description: "The message type code of the message queue.\n " nullable: true information: type: string description: "The reason why the message was added to the database.\n \ \ " nullable: true body: type: string description: "The body of the message.\n " nullable: true messageKey: type: string description: "The message key.\n " nullable: true MessageBase: type: object description: "The message base model.\n " additionalProperties: false properties: typeCode: type: string description: "The message type code of the message queue.\n " nullable: true information: type: string description: "The reason why the message was added to the database.\n \ \ " nullable: true body: type: string description: "The body of the message.\n " nullable: true GenericTeletypeMessageRequest: type: object description: "Defines the send generic teletype message request.\n \ \ " additionalProperties: false required: - fromAddress - toAddress - body properties: fromAddress: type: string description: "The address of the message sender.\n " maxLength: 8 minLength: 7 toAddress: type: string description: "The address of the message recipient.\n " maxLength: 8 minLength: 7 body: type: string description: "The message body.\n " minLength: 1 IJsonResponseOfIListOfQueueCategory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/QueueCategory' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' QueueCategory: type: object description: "The Queue Category model.\n " additionalProperties: false properties: queueCategoryCode: type: string description: "The queue category code of queue category.\nPlease note that\ \ this should be a char and not a string.\n " maxLength: 1 nullable: true name: type: string description: "The name of the queue category\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The InActive of QueueCategory.\n " allowed: type: boolean description: "The Allowed Class Of Service.\n " IJsonResponseOfQueueCategory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/QueueCategory' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfDequeueTravelSummary: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/DequeueTravelSummary' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' DequeueTravelSummary: type: object description: "Represents an travel entry when dequeued.\n " additionalProperties: false required: - information properties: travelQueueKey: type: string description: "The unique travel queue item key.\n " nullable: true information: description: "Market designator.\n " $ref: '#/components/schemas/MarketInformation' notes: type: string description: "Notes.\n " nullable: true priorityCode: type: string description: "Priority code.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 nullable: true priorityDate: type: string description: "Priority date.\n " format: date-time nullable: true processStatus: description: "Process status.\n " $ref: '#/components/schemas/QueueProcessStatus' processState: description: "Process state.\n " $ref: '#/components/schemas/QueueProcessState' inProgress: type: boolean description: "Status.\n " statusReset: type: string description: "Date status reset.\n " format: date-time nullable: true summary: description: "Travel summary.\n " nullable: true $ref: '#/components/schemas/TravelSummary' QueueProcessStatus: type: integer description: "QueueProcessStatus specifies the basis by which queue filters\ \ are created.\n \n\n0 = Ready\n1 = Pending" x-enumNames: - Ready - Pending enum: - 0 - 1 QueueProcessState: type: integer description: "QueueProcessState specifies the basis by which queue filters are\ \ created.\n \n\n0 = Default\n1 = SegmentsConfirmed\n2 = BookingBalanced\n\ 4 = Other\n7 = Complete" x-enumNames: - Default - SegmentsConfirmed - BookingBalanced - Other - Complete enum: - 0 - 1 - 2 - 4 - 7 TravelQueueItemRequest: type: object description: "API request object used to enqueue a new travel queue item.\n\ \ " additionalProperties: false required: - item - queue properties: item: description: "Flight queue item to enqueue on the matching flight queues.\n\ \ " $ref: '#/components/schemas/TravelQueueItemBase' queue: description: "Queue information about this item.\n " $ref: '#/components/schemas/TravelQueueRequest' queueEventCode: type: string description: "Queue event code used for matching flight queues.\n \ \ " nullable: true timeEventCode: type: string description: "Time event code used for matching flight queues.\n \ \ " nullable: true TravelQueueItemBase: type: object description: "Model representing the travel queue item without a unique key.\n\ \ " additionalProperties: false required: - information properties: processStatus: description: "Process status.\n " $ref: '#/components/schemas/QueueProcessStatus' processState: description: "Process state.\n " $ref: '#/components/schemas/QueueProcessState' inProgress: type: boolean description: "Status.\n " statusReset: type: string description: "Date status reset.\n " format: date-time nullable: true information: description: "Market designator.\n " $ref: '#/components/schemas/MarketInformation' notes: type: string description: "Notes.\n " nullable: true priorityCode: type: string description: "Priority code.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 nullable: true priorityDate: type: string description: "Priority date.\n " format: date-time nullable: true TravelQueueRequest: type: object description: "Defines a travel queue query.\n " additionalProperties: false required: - travelQueueCode properties: travelQueueCode: type: string description: "The required queue code.\n " minLength: 1 subQueueCode: type: string description: "The optional sub queue code.\n " nullable: true IJsonResponseOfQueueResults: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/QueueResults' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' QueueResults: type: object description: "Base class for all queue model objects\n " additionalProperties: false properties: queues: type: array description: "Queues.\n " nullable: true items: $ref: '#/components/schemas/Queue' totalCount: type: integer description: "The total available count.\n " format: int32 lastPageIndex: type: integer description: "Last page index used for paging.\n " format: int64 IJsonResponseOfBookingQueueItemBase: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BookingQueueItemBase' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingQueueItemBase: type: object description: "Defines a Booking Queue item.\n " additionalProperties: false properties: processStatus: description: "Process status.\n " $ref: '#/components/schemas/QueueProcessStatus' processState: description: "Process state.\n " $ref: '#/components/schemas/QueueProcessState' inProgress: type: boolean description: "Status.\n " statusReset: type: string description: "Date status reset.\n " format: date-time nullable: true bookingQueueItemKey: type: string description: "The booking queue item key.\n " nullable: true segmentKey: type: string description: "The segment key of the flight associated with the booking\ \ queue entry.\n " nullable: true watchListId: type: integer description: "The WatchList Id of the booking queue entry.\n " format: int64 nullable: true passengerId: type: integer description: "Passenger Id if associated to a passenger.\n " format: int64 nullable: true domainCode: type: string description: "Domain code of the booking queue entry.\n " nullable: true note: type: string description: "Free-form note field of the booking queue entry.\n \ \ " nullable: true passengerName: description: "Passenger name of the booking queue entry.\n " nullable: true $ref: '#/components/schemas/Name' priorityDate: type: string description: "Priority date of the booking queue entry.\n " format: date-time nullable: true eventType: description: "The booking queue event type that caused the booking queue\ \ entry to be created.\n " $ref: '#/components/schemas/QueueEventType' restriction: description: "The restrictions associated with the booking queue.\n \ \ " $ref: '#/components/schemas/BookingQueueRestriction' recordLocator: type: string description: "The booking record locator associated with the booking queue\ \ entry.\n " nullable: true createdDate: type: string description: "The date and time when the booking was queued.\n \ \ " format: date-time nullable: true BookingQueueReleaseRequest: type: object description: "Defines a booking queue query\n " additionalProperties: false properties: queuePassword: type: string description: "The password for the queue if required.\n " nullable: true IJsonResponseOfMessagesSearchResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/MessagesSearchResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' MessagesSearchResponse: type: object description: "The paged message response.\n " additionalProperties: false properties: messageQueueCount: type: integer description: "The total number of messages in the queue.\n " format: int32 lastPageKey: type: string description: "The last index of the paged response.\n " nullable: true teletypeMessages: type: array description: "The collection of messages in the queue.\n " nullable: true items: $ref: '#/components/schemas/MessageResponsev2' MessageResponsev2: type: object description: "The teletype message response.\n " additionalProperties: false properties: typeCode: type: string description: "The message type code of the message queue.\n " nullable: true information: type: string description: "The reason why the message was added to the database.\n \ \ " nullable: true body: type: string description: "The body of the message.\n " nullable: true messageKey: type: string description: "The unique message key.\n " nullable: true fromAddress: description: "The address of the message sender.\n " nullable: true $ref: '#/components/schemas/MessageAddress' toAddress: description: "The address of the message recipient.\n " nullable: true $ref: '#/components/schemas/MessageAddress' createdDate: type: string description: "The date in which the message was created.\n " format: date-time MessageAddress: type: object description: "Defines the message address.\n " additionalProperties: false properties: carrier: type: string description: "The carrier segment of the address.\n " nullable: true city: type: string description: "The city segment of the address.\n " nullable: true office: type: string description: "The office segment of the address.\n " nullable: true MessageQueueHiddenOptions: type: integer description: "Represents values for message queue record filter.\n \ \ \n\n0 = NonHiddenRecords\n1 = HiddenRecords\n2 = All" x-enumNames: - NonHiddenRecords - HiddenRecords - All enum: - 0 - 1 - 2 SearchType: type: integer description: "Enumeration of possible ways to do a search inquiry.\n \ \ \n\n0 = StartsWith\n1 = EndsWith\n2 = Contains\n3 = ExactMatch" x-enumNames: - StartsWith - EndsWith - Contains - ExactMatch enum: - 0 - 1 - 2 - 3 IJsonResponseOfIListOfCarrier: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Carrier' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Carrier: type: object description: "The carrier model.\n " additionalProperties: false required: - carrierCode - carrierInfo - carrierName - carrierShortName - phone - url properties: carrierCode: type: string description: "The carrier code for this carrier.\n " maxLength: 3 minLength: 2 carrierInfo: type: string description: "The carrier info for this carrier.\n " maxLength: 60 minLength: 0 carrierName: type: string description: "The carrier name for this carrier.\n " maxLength: 64 minLength: 0 carrierShortName: type: string description: "The carrier short name for this carrier.\n " maxLength: 32 minLength: 0 carrierType: type: string description: "The carrier type for this carrier.\nPlease note that this\ \ should be a char and not a string.\n " maxLength: 1 nullable: true eTicketIndicator: type: boolean description: "The e ticket indicator for this carrier.\n " inventoryIndicator: type: boolean description: "The inventory indicator for this carrier\n " phone: type: string description: "The phone number for this carrier.\n " maxLength: 20 minLength: 0 url: type: string description: "The Url for this carrier.\n " maxLength: 2048 minLength: 0 baggageIndicator: type: string description: "The baggage indicator for this carrier.\nPlease note that\ \ this should be a char and not a string.\n " maxLength: 1 nullable: true iataAccountingCode: type: string description: "The numerical IATA accounting code for this carrier.\n \ \ " nullable: true IJsonResponseOfCarrier: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Carrier' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfResourceContentItem: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ResourceContentItem' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ResourceContentItem: type: object description: "Model representing a resource content item.\n " additionalProperties: false required: - contentId properties: contentId: type: integer description: "The content id.\n " format: int64 name: type: string description: "Name of the content\n " nullable: true description: type: string description: "Description of the content.\n " nullable: true cultureCode: type: string description: "Culture code of the data.\n " nullable: true size: type: integer description: "Size in bytes of the data.\n " format: int64 type: description: "Specific content type.\n " $ref: '#/components/schemas/ContentType' dataType: description: "Content data type.\n " $ref: '#/components/schemas/ContentDataType' data: type: string description: "Data bytes.\n " format: byte nullable: true ContentType: type: integer description: "Content Type enumeration.\n \n\n0 = GeneralReference\n\ 1 = News\n2 = ConsoleHelp\n3 = FareRuleReference\n4 = ReviewWithCustomer\n\ 8 = Image\n9 = PromotionReference\n10 = SubscriptionReference" x-enumNames: - GeneralReference - News - ConsoleHelp - FareRuleReference - ReviewWithCustomer - Image - PromotionReference - SubscriptionReference enum: - 0 - 1 - 2 - 3 - 4 - 8 - 9 - 10 IJsonResponseOfIEnumerableOfResourceContentResult: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ResourceContentResult' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ResourceContentResult: type: object description: "Model representing a resource content item.\n " additionalProperties: false required: - contentId properties: contentId: type: integer description: "The content id.\n " format: int64 name: type: string description: "Name of the content\n " nullable: true description: type: string description: "Description of the content.\n " nullable: true type: description: "Specific content type.\n " $ref: '#/components/schemas/ContentType' cultureCode: type: string description: "Culture code.\n " nullable: true IJsonResponseOfIListOfCulture: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Culture' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Culture: type: object description: "Defines a culture code.\n " additionalProperties: false required: - cultureCode properties: cultureCode: type: string description: "The unique code for the culture.\n " maxLength: 17 minLength: 1 name: type: string description: "The display name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The flag indicating if the resource is inactive.\n \ \ " IJsonResponseOfCulture: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Culture' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfTailNumberInventoryItem: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/TailNumberInventoryItem' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TailNumberInventoryItem: type: object description: "The tail number inventory item model.\n " additionalProperties: false properties: tailNumber: type: string description: "The tail number.\n " maxLength: 10 minLength: 0 nullable: true equipmentType: type: string description: "The associated equipment type.\n " maxLength: 3 minLength: 0 nullable: true equipmentTypeSuffix: type: string description: "The associated equipment type suffix.\n " maxLength: 3 minLength: 0 nullable: true IJsonResponseOfIListOfEquipmentConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/EquipmentConfiguration' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' EquipmentConfiguration: type: object description: "Defines the equipment or aircraft that is used for flight operations.\n\ \ " additionalProperties: false properties: type: type: string description: "The type of the equipment.\n " nullable: true typeSuffix: type: string description: "The suffix associated with the equipment type.\n \ \ " nullable: true name: type: string description: "The name of the equipment.\n " nullable: true active: type: boolean description: "Indicates if the equipment is active or inactive.\n \ \ " IJsonResponseOfIListOfEnumResource: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/EnumResource' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' EnumResource: type: object description: "Provide localization information about an enumeration.\n \ \ " additionalProperties: false required: - code properties: code: type: integer description: "The unique property code.\n " description: type: string description: "The description.\n " nullable: true IJsonResponseOfIListOfNonBinaryGender: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/NonBinaryGender' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' NonBinaryGender: type: object description: "The non-binary genders defined in the system.\n " additionalProperties: false properties: code: type: string description: "The unique gender code.\n " nullable: true name: type: string description: "The gender name.\n " nullable: true inActive: type: boolean description: "Indicates if the gender is active or not.\n " IJsonResponseOfNonBinaryGender: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/NonBinaryGender' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfOperationsSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/OperationsSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' OperationsSettings: type: object description: "The operations settings, also known as Departure Control settings.\n\ \ " additionalProperties: false properties: overrideOverWingExitRowRequirement: type: boolean description: "The role setting to allow/disallow overriding over-wing exit\ \ row requirement.\n " iropFromDepartureDateOffset: type: string description: "Indicates the number of days prior to the current date a flight\ \ can depart and still\nhave passengers moved under IROP by those with\ \ a particular role.\n " format: duration allowDiversionIrop: type: boolean description: "In order to access the diversion functionality in IROP, agent\ \ must be\nassigned this permission.\n " allowConsoleIrop: type: boolean description: "Allows users with this role access to access IROP utility\ \ through the Console.\n " allowCreateAdHocConnectionsInIrop: type: boolean description: "Select to enable users with this role to create ad hoc connections\ \ through the IROP\nutility. If an agent does not have this permission,\ \ they are only able to choose 'r;To Flight'\nconnection options if they\ \ are already available in the Flight schedule.\n " allowIropOversellOnToFlight: type: boolean description: "Whether an IROP oversell is allowed or not.\n " flightFollowingAccessControl: description: "The access to flight following information allowed on this\ \ role.\n " $ref: '#/components/schemas/AccessControl' allowAircraftMishapUtilityAccess: type: boolean description: "Whether Aircraft Mishap Utility Access is allowed or not.\n\ \ " allowCheckedBaggageWeightChange: type: boolean description: "Whether Checked Baggage Weight Change is allowed.\n \ \ " allowOpeningOfClosedFlights: type: boolean description: "Whether opening of closed flights is allowed or not.\n \ \ " timeBeforeDepartureThatCloseFlightIsAllowed: type: string description: "Indicates the time before departure that close flight is allowed.\n\ \ " format: duration timeAfterDepartureThatOpenFlightIsAllowed: type: string description: "Indicates the time before departure that open flight is allowed.\n\ \ " format: duration allowClearPassengerDataInAircraftMishap: type: boolean description: "Whether clearing passenger data in the event of an aircraft\ \ mishap is allowed or not.\n " allowRestorePassengerDataInAircraftMishap: type: boolean description: "Whether restoring passenger data in the event of an aircraft\ \ mishap is allowed or not.\n " allowInventoryStatusChange: type: boolean description: "Whether changing the flight status is allowed or not. This\ \ is mainly used for setting flights to closed or closed\npending status.\ \ This does not allow opening a flight, for opening a flight see the AllowOpeningOfClosedFlights\n\ setting\n " adHocFromCurrentDateOffset: type: string description: "Indicates the number of days before and after the current\ \ date for which ad hoc Flights can be created. For\nexample, if set to\ \ one, agents can create an ad hoc Flight for tomorrow but not further\ \ out.\n " format: duration bagDropMode: description: "Indicates whether the bag drop mode is Normal or Advanced.\ \ If set to Advanced, passenger and number of bags is\ndisplayed for the\ \ user when a boarding pass is scanned.\n " $ref: '#/components/schemas/BagDropMode' allowCrewBagAccess: type: boolean description: "Whether or not users with this role has access to the CREW\ \ bag options for crew baggage that is being checked in.\n " allowRushBagAccess: type: boolean description: "Whether or not users with this role has access to the RUSH\ \ bag options for mishandled baggage that must be\nexpedited.\n \ \ " allowCrewBagCheckInWhenFlightIsClosedPending: type: boolean description: "Whether or not users with this role can check-in baggage with\ \ CREW tag on a flight with \"Closed Pending\" status.\n " allowRushBagCheckInWhenFlightIsClosedPending: type: boolean description: "Whether or not users with this role can check-in baggage with\ \ RUSH baggage tags on a flight with \"Closed Pending\"\nstatus.\n \ \ " allowMarketingCheckIn: type: boolean description: "Whether or not users with this role are allowed to check-in\ \ passengers of marketing flights.\n " verifyAPISInternationalFlight: type: boolean description: "Whether or not users with this role are allowed to set international\ \ Flights verified in APIS.\n " allowInventorySSRMaintenanceUpdate: type: boolean description: "Whether or not users with this role are allowed to access\ \ the Inventory SSR Maintenance Update.\n " allowInventoryRecordMaintenanceUpdate: type: boolean description: "Whether or not users with this role are allowed to access\ \ the Inventory Record Maintenance Update utility.\n " allowCancelRestoreInventory: type: boolean description: "Whether or not users with this role are allowed to cancel\ \ and restore inventory.\n " allowDiversionAdHoc: type: boolean description: "Whether or not users with this role are allowed to access\ \ the diversion functionality in AdHoc.\n " allowManageTailNumber: type: boolean description: "Whether or not users with this role are allowed to access\ \ the Tail Number utility.\n " allowEquipmentSwapUtilityAccess: type: boolean description: "Whether or not users with this role are allowed to access\ \ the Equipment Swap utility.\n " allowRZAccess: type: boolean description: "Whether or not users with this role are allowed to create\ \ and modify basic reservations with RZ.\n " allowUpdateStandbyPriorityCode: type: boolean description: "Whether or not users with this role are allowed to update\ \ the standby priority codes for bookings.\n " allowManageVoucher: type: boolean description: "Whether or not users with this role are allowed to access\ \ the Voucher Utility.\n " flightInformationPermissions: description: "Indicates the level of access this role has for the Flight\ \ Information API.\n " $ref: '#/components/schemas/AccessControl' allowSegmentsByTime: type: boolean description: "Whether or not users with this role are allowed to search\ \ for segments by time.\n " allowBaggageTrackingAccess: type: boolean description: "Allows agents with this role to access the Baggage Tracking\ \ utility.\n " enableFlightSearchRestrictionByOrigin: type: boolean description: "Whether or not users with this role are restricted from searching\ \ flights based on origin.\n " allowBaggageModeSwitchToIBCMode: type: boolean description: "Whether or not users with this role are allowed to switch\ \ default Baggage mode to IBC (Interline Baggage\nCalculator) mode.\n\ \ " daysForwardAllowedForSearchingCheckInAndReports: type: string description: "Indicates the number of days after the current date this user\ \ can search for Check-In reports.\n " format: duration daysPriorAllowedForSearchingCheckInAndReports: type: string description: "Indicates the number of days prior to the current date this\ \ user can search for Check-In reports.\n " format: duration sendAPISReport: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and send the APIS (Advance Passenger Information\nSystem) report.\n\ \ " watchList: description: "Watch list operations settings.\n " nullable: true $ref: '#/components/schemas/WatchListSettings' programs: description: "Programs operations settings.\n " nullable: true $ref: '#/components/schemas/ProgramsSettings' reports: description: "Reports operations settings.\n " nullable: true $ref: '#/components/schemas/ReportsSettings' AccessControl: type: integer description: "Defines the user permission levels for managing various operations.\n\ \ \n\n0 = None\n1 = Read\n2 = Create\n3 = Update\n4 = Delete\n\ 5 = ReadUpdate\n6 = CreateReadUpdate\n7 = All" x-enumNames: - None - Read - Create - Update - Delete - ReadUpdate - CreateReadUpdate - All enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 BagDropMode: type: integer description: "This enumeration represents the bag drop modes.\n \n\ \n0 = Normal\n1 = Advanced" x-enumNames: - Normal - Advanced enum: - 0 - 1 WatchListSettings: type: object description: "Watch list settings sub-group of the Operations Settings (aka\ \ Department Control)\n " additionalProperties: false properties: allowViewForWatchList: type: boolean description: "Whether or not users with this role are allowed to access\ \ the Watch List options to view detailed or clear\npassenger watch list.\n\ \ " allowDetailViewForWatchList: type: boolean description: "Whether or not users with this role are allowed a Detailed\ \ View of Watch List Matches. This permission requires the\nuser be assigned\ \ the AllowViewForWatchList permission.\n " allowClearPassengerFromWatchList: type: boolean description: "Whether or not users with this role are allowed to remove\ \ entries from a Watch List. To have this permission, the\nuser must be\ \ assigned the AllowDetailViewForWatchList permission.\n " ProgramsSettings: type: object description: "Programs Settings sub-group of Operations Settings (aka Department\ \ Control)\n " additionalProperties: false properties: sendSITAMessage: type: boolean description: "Whether or not users with this role are allowed to send SITA\ \ (Soci\xE9t\xE9 Internationale de T\xE9l\xE9communications\nA\xE9ronautiques)\ \ messages.\n " sendMessage: type: boolean description: "Whether or not users with this role are allowed to send messages\ \ (not through the SITA system) to other stations\nand printers.\n \ \ " adHocScheduleInventoryConnections: type: boolean description: "Whether or not users with this role are allowed to create\ \ an ad/hoc Flight and build connections to it.\n " allowCAPPSReportAccess: type: boolean description: "Whether or not users with this role are allowed access to\ \ the CAPPS (Computer-Assisted Passenger Pre-screening\nSystem) report.\n\ \ " allowCheckInSelectee: type: boolean description: "Whether or not users with this role are allowed to check-in\ \ selectee passengers.\n " ReportsSettings: type: object description: "Reports Settings sub-group of the Operations Settings (aka Department\ \ Control)\n " additionalProperties: false properties: enplanementDeplanement: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Enplanement and Deplanement reports.\n " manifestConnectionInfo: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view the manifest connection info reports.\n " manifestDetailedInfo: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Manifest with Detailed Information reports.\n " flightLoad: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Flight Load reports.\n " checkIn: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Check-In reports.\n " aircraftZone: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Aircraft Zone reports.\n " seatAssignment: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Seat Assignment reports.\n " flightClose: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Flight Close reports.\n " paymentReceipt: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Payment Receipt reports.\n " paymentReceiptConfigurations: description: "Payment receipt report configurations.\n " nullable: true $ref: '#/components/schemas/PaymentReceiptReportConfigurations' checkedBaggage: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Checked Baggage reports.\n " availability: type: boolean description: "Whether or not users with this role are allowed to generate\ \ view Availability reports.\n " bagWeightByLeg: type: boolean description: "Whether or not users with this role are allowed to generate\ \ view Bag Weight by Leg reports.\n " selecteesByFlight: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Flight Manifest reports by Selectee.\n " mealFulfillment: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Meal Fulfillment reports.\n " flightManifest: type: boolean description: "Whether or not users with this role are allowed to view Flight\ \ Manifests\n " flightManifestConfigurations: description: "The search configurations for the Flight Manifest reports.\n\ \ " nullable: true $ref: '#/components/schemas/FlightManifestReportConfigurations' prePostFlightManifest: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Pre/Post Flight Manifest reports.\n " cabinServiceArea: type: boolean description: "Whether or not users with this role are allowed to generate\ \ and view Cabin Service Area reports.\n " displayPNRInCabinServiceAreaAndMealFulfillmentReports: type: boolean description: "Whether or not users with this role are allowed to include\ \ the PNR (Passenger Name Record) when the In-Cabin\nService Area and\ \ Meal Fulfillment report is generated.\n " PaymentReceiptReportConfigurations: type: object description: "Reports Settings sub-group of the Operations Settings (aka Department\ \ Control)\n " additionalProperties: false properties: displayLocationPrompt: type: boolean description: "Whether or not users with this role need to display the location\ \ prompt for the payment receipt reports.\n " FlightManifestReportConfigurations: type: object description: "Flight Manifest Reports Configurations sub-group of the Operations\ \ Settings (aka Department Control)\n " additionalProperties: false properties: identifySelecteePassengers: type: boolean description: "Whether or not users with this role are allowed to include\ \ selectee passengers in the report.\n " identifyPassengersWithBalanceDue: type: boolean description: "Whether or not users with this role are allowed to include\ \ passengers with balance due in the report.\n " IJsonResponseOfPrinter: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Printer' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Printer: type: object description: "Represents a printer.\n " additionalProperties: false properties: code: type: string description: "The printer code.\n " nullable: true name: type: string description: "The printer name.\n " nullable: true IJsonResponseOfIListOfPrinter: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Printer' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfListOfRoleSettingv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/RoleSettingv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' RoleSettingv2: type: object description: "The role settings model.\n " additionalProperties: false required: - code properties: code: type: string description: "The code for the role setting type.\n " maxLength: 20 minLength: 0 name: type: string description: "The name for the role setting type.\n " maxLength: 64 minLength: 0 nullable: true CreateRoleRequest: type: object description: "Create role request.\n " additionalProperties: false required: - roleCode - name - parentRoleCode properties: roleCode: type: string description: "The unique role code.\n " maxLength: 4 minLength: 1 name: type: string description: "The role's name.\n " minLength: 1 parentRoleCode: type: string description: "Gets or sets the parent role code for this role.\n \ \ " maxLength: 4 minLength: 1 IJsonResponseOfResourceCategoryItem: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ResourceCategoryItem' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ResourceCategoryItem: type: object description: "Model representing a resource setting category item.\n \ \ " additionalProperties: false required: - resourceCategoryItemId - resourceCategoryItemTypeCode - name - resourceCategoryId properties: contentType: description: "The default content type.\n " $ref: '#/components/schemas/ResponseContentType' resourceCategoryItemId: type: integer description: "The resource id.\n " format: int64 resourceCategoryItemTypeCode: type: string description: "The resource type code.\n " maxLength: 3 minLength: 1 name: type: string description: "The name.\n " maxLength: 64 minLength: 0 resourceCategoryId: type: integer description: "The resource category id.\n " format: int64 cannotDelete: type: boolean description: "The delete permissions.\n " data: type: string description: "The resource data.\n " maxLength: 1073741823 minLength: 0 nullable: true ResponseContentType: type: integer description: "Defines the content data type enumeration.\n \n\n0\ \ = Unknown\n1 = Json\n2 = Xml" x-enumNames: - Unknown - Json - Xml enum: - 0 - 1 - 2 SettingsCategoryRequest: type: object description: "Model representing a settings category request.\n " additionalProperties: false required: - path properties: path: type: string description: "The path of the setting. Example: Web\\dotREZ\\MarketFilterSettings.\n\ \ " minLength: 1 IJsonResponseOfFinanceSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FinanceSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FinanceSettings: type: object description: "System configuration - finance.\n " additionalProperties: false properties: financeAccess: description: "Gets or Sets the level of access allowed on managing finance\ \ data.\n " $ref: '#/components/schemas/AccessControl' financeData: description: "Gets or Sets the finance data.\n " nullable: true $ref: '#/components/schemas/FinanceSettingsData' manageFinancialControlLockDate: description: "Gets or Sets the level of access allowed in managing the financial\ \ control lock date.\n " $ref: '#/components/schemas/ClosedFlightControlDateType' FinanceSettingsData: type: object description: "System configuration - finance data or container.\n \ \ " additionalProperties: false properties: manageAccounts: description: "Gets or Sets the level of access allowed on managing accounts.\n\ \ " $ref: '#/components/schemas/AccessControl' manageCreditTypes: description: "Gets or Sets the level of access allowed on managing credit\ \ types.\n " $ref: '#/components/schemas/AccessControl' manageCurrency: description: "Gets or Sets the level of access allowed on managing currency.\n\ \ " $ref: '#/components/schemas/AccessControl' manageFareDiscountCodes: description: "Gets or Sets the level of access allowed on managing fare\ \ discount codes.\n " $ref: '#/components/schemas/AccessControl' manageFareSurcharges: description: "Gets or Sets the level of access allowed on managing fare\ \ surcharges\n " $ref: '#/components/schemas/AccessControl' managePaymentTypes: description: "Gets or Sets the level of access allowed on managing payment\ \ types.\n " $ref: '#/components/schemas/AccessControl' managePromotionCodes: description: "Gets or Sets the level of access allowed on managing promotion\ \ codes.\n " $ref: '#/components/schemas/AccessControl' manageTaxesAndFees: description: "Gets or Sets the level of access allowed on managing taxes\ \ and fees.\n " $ref: '#/components/schemas/AccessControl' allowAgentToImportFeeVariations: type: boolean description: "Gets or Sets the level of access allowed in allowing agent\ \ to import fee variations .\n " manageVouchers: description: "Gets or Sets the level of access allowed on managing vouchers.\n\ \ " $ref: '#/components/schemas/AccessControl' allowAccountReconciliation: type: boolean description: "Gets or Sets the level of access allowed in allowing agent\ \ to access Account Reconciliation.\n " allowBalanceAndCreditLimitUpdate: type: boolean description: "Gets or Sets the level of access allowed in allowing agent\ \ to access Balance And Credit Limit Update.\n " allowAccountStatementAdjustment: type: boolean description: "Gets or Sets the level of access allowed in allowing agent\ \ to access Statement Adjustment.\n " ClosedFlightControlDateType: type: integer description: "This enumeration represents the closed flight control date type.\n\ \ \n\n0 = ViewDate\n1 = ViewAndMoveDateForward\n2 = ViewAndMoveDateForwardOrBackward" x-enumNames: - ViewDate - ViewAndMoveDateForward - ViewAndMoveDateForwardOrBackward enum: - 0 - 1 - 2 IJsonResponseOfIListOfRolev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Rolev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Rolev2: type: object description: "Represents information about a role.\n " additionalProperties: false properties: roleCode: type: string description: "The unique role code.\n " nullable: true name: type: string description: "The role's name.\n " nullable: true parentRoleCode: type: string description: "Gets or sets the parent role code for this role.\n \ \ " maxLength: 4 minLength: 1 nullable: true IJsonResponseOfRolev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Rolev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfSeatPropertyType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SeatPropertyType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SeatPropertyType: type: object description: "Represents a seat property type used to represent properties of\ \ seats in an equipment configuration.\n " additionalProperties: false properties: code: type: string description: "Seat property type code.\n " nullable: true name: type: string description: "The name of the seat property type.\n " nullable: true kind: description: "The value type that the seat property represents.\n \ \ " $ref: '#/components/schemas/SeatPropertyTypeKind' values: type: array description: "The list of possible values that could represent a seat property.\n\ \ " nullable: true items: $ref: '#/components/schemas/SeatPropertyValue' isSearchable: type: boolean description: "Indicates when the seat property type is included in a list\ \ of searchable properties in the seat assignment\nalgorithm.\n \ \ " SeatPropertyTypeKind: type: integer description: "Seat property type kind enumeration.\n \n\n0 = None\n\ 1 = Boolean\n2 = Numeric\n3 = List\n4 = String\n5 = SsrPermission" x-enumNames: - None - Boolean - Numeric - List - String - SsrPermission enum: - 0 - 1 - 2 - 3 - 4 - 5 SeatPropertyValue: type: object description: "Represents a possible value of a seat property type.\n \ \ " additionalProperties: false properties: code: type: string description: "Seat property value code.\n " nullable: true name: type: string description: "The name of a seat property value.\n " nullable: true IJsonResponseOfIListOfSeatPropertyType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/SeatPropertyType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPremiumServicesSettingsv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PremiumServicesSettingsv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PremiumServicesSettingsv2: type: object description: "Settings for the premium services.\n " additionalProperties: false properties: accessToExternalBaggageSystems: type: boolean description: "The value to indicate if access to external baggage\nsystems\ \ is enabled.\n " advancedParentChildTravelAgencyManagement: type: boolean description: "The value to indicate if advanced parent child travel agency\n\ managment is enabled.\n " baggageSelfTagging: type: boolean description: "The value to indicate if baggage self tagging is enabled.\n\ \ " loyaltyCustomerAccountView: type: boolean description: "The value to indicate if the loyalty customer account view\ \ is enabled.\n " pricingOptimizationServices: type: boolean description: "The value to indicate if pricing optimization services are\ \ enabled.\n " secureFlight: type: boolean description: "The value to indicate if secure flight is enabled.\n \ \ " allInclusivePricingDisplay: type: boolean description: "The value to indicate if all inclusive pricing display is\ \ enabled.\n " numericAddressVerificationService: type: boolean description: "The value to indicate if the numeric address verification\ \ service\nis enabled.\n " koreanInteractiveAdvancePassengerProcessing: type: boolean description: "The value to indicate if interactive advance passenger processing\n\ is enabled for the Korean government.\n " taiwanInteractiveAdvancePassengerProcessing: type: boolean description: "The value to indicate if interactive advance passenger processing\n\ is enabled for the National Immigration Agency (NIA) of Taiwan.\n \ \ " canadaInteractiveAdvancePassengerProcessing: type: boolean description: "The value to indicate if interactive advance passenger processing\n\ is enabled for the Canada Border Services Agency (CBSA).\n " attributeShopping: type: boolean description: "The value to indicate if attribute shopping is enabled.\n\ \ " documentCheckConfiguration: type: boolean description: "The value to indicate if document check configuration is enabled.\n\ \ " transmitFareDataToAirlineTariffPublishingCompany: type: boolean description: "The value to indicate if the transmission of fares data to\ \ the\nairline tariff publishing company feature is enabled.\n \ \ " travelNotifications: type: boolean description: "The value to indicate if travel notifications are enabled.\n\ \ " bundles: type: boolean description: "The value to indicate if service bundles are enabled.\n \ \ " governmentDataProtectionRequirements: type: boolean description: "The value to indicate if the government data protection requirements\n\ are enabled.\n " unitedKingdomInteractiveAdvancePassengerProcessing: type: boolean description: "The value to indicate if interactive advance passenger processing\n\ is enabled for the United Kingdom.\n " doNotPersistExternalPaymentDetails: type: boolean description: "Indicates if the external payment details are allowed to be\ \ stored in the system.\n " IJsonResponseOfSkySpeedSettingsv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SkySpeedSettingsv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SkySpeedSettingsv2: type: object description: "Settings for Sky Speed.\n " additionalProperties: false properties: manifestViewDate: description: "The value to indicate what type of date to display in the\ \ SkySpeed manifest view.\n " $ref: '#/components/schemas/ManifestViewDateType' maximumNumberOfTtyMessagesPerBatchForDeletion: type: integer description: "The value to indicate the maximum number of TTY messages\n\ per batch for deletion.\n " format: int32 postalCodeLookup: description: "The value to indicate the manner in which postal codes will\ \ be looked up\nin SkySpeed.\n " $ref: '#/components/schemas/PostalCodeLookupType' serviceServerName: type: integer description: "The value to indicate the server name of the primary service.\n\ \ " format: int32 enableViewPaymentAllocation: type: boolean description: "Enable view payment allocation.\n " disableBaseCurrency: type: boolean description: "Disables base currency when searching flights.\n \ \ " disableOutboundTime: type: boolean description: "Disables outbound time when searching flights.\n \ \ " excludeOutboundTimeTab: type: boolean description: "Excludes the outbound time from tab order.\n " disableReturnTime: type: boolean description: "Disables return time when searching flights.\n " excludeReturnTimeTab: type: boolean description: "Excludes return time from tab order.\n " enableShowValidFaresCheckbox: type: boolean description: "Enable check box to 'Show Only Fares Valid for Given Number\ \ of Passengers'.\n " fareBasisInRegularBooking: type: integer description: "Indicates fare basis significance in regular booking mode.\n\ \ " format: int32 fareBasisInOverbook: type: integer description: "Indicates fare basis significance in overbook mode.\n \ \ " format: int32 displayReservedFlights: type: boolean description: "Display the reserved flights dialog after reserving a flight.\n\ \ " displaySsrNestValues: type: boolean description: "Display the SSR nest values.\n " defaultFocusToCustomerIdField: type: boolean description: "Set cursor to customer id field in add name dialog.\n \ \ " allowDeleteComments: type: boolean description: "Allow comments to be deleted.\n " promptCreateInternetUserId: type: boolean description: "Prompt to create SkySales user id after creating customer\ \ account.\n " allowManagePasswordForCustomerAccount: type: boolean description: "Allow password management for customer accounts.\n \ \ " viewFareQuote: type: boolean description: "View fare quote dialog.\n " allowNonCarrierOrgToUseOtherAgency: type: boolean description: "Allow non carrier org to use other agency.\n " viewTeletypeProcessing: type: boolean description: "View teletype processing dialog.\n " viewGdsHistoryDialog: type: boolean description: "View GDS history dialog.\n " returnDateDefaultToOutboundDate: type: boolean description: "Return date default to outbound date.\n " displayFyiNotesOnLogin: type: boolean description: "Display FYI notes on login.\n " displayResidentCountry: type: boolean description: "Display resident country control.\n " displayPricesByPassengerType: type: array description: "Display prices by passenger type (Restrict or Allow).\n \ \ " nullable: true items: type: string defaultToCustomerCreditCard: type: boolean description: "Default payment to the first credit card of the customer.\n\ \ " forceViewMandatoryComments: type: boolean description: "Force view mandatory comments on change booking.\n \ \ " showTravelDocumentsOnPassengersScreen: type: boolean description: "Show travel document tab on the passengers screen.\n \ \ " showDestinationAddressesOnPassengersScreen: type: boolean description: "Show the destination address tab on the passengers screen.\n\ \ " showFrequentFlyerNumberOnPassengersScreen: type: boolean description: "Show the frequent flyer number tab on the passengers screen.\n\ \ " showMealSsrButtonOnPassengersScreen: type: boolean description: "Show the meal SSR button on the passengers screen.\n \ \ " allowETicketing: type: boolean description: "Allow e-ticketing.\n " allowFeesToBeDeleted: type: boolean description: "Allow fees to be deleted.\n " displayReferenceNumber: type: boolean description: "Display reference number.\n " enableLoyaltyCustomerAccountView: type: boolean description: "Enable loyalty customer account view.\n " enableLoyaltyFareDisplay: type: boolean description: "Enable loyalty fare display.\n " displayETicketRecords: type: boolean description: "Display e-ticket records.\n " allowETicketCouponStatusToBeUpdated: type: boolean description: "Allow e-ticket coupon status to be updated.\n " enableRepriceButtonOnReservedFlightsScreen: type: boolean description: "Enable reprice button on the reserved flights screen.\n \ \ " enableSplitCancelButtonOnReservedFlightsScreen: type: boolean description: "Enable reprice button on the reserved flights screen.\n \ \ " allowTravelNotificationsAccess: type: boolean description: "Allow access to traveler notification dialogs.\n \ \ " allowThemeEditorAccess: type: boolean description: "Allow theme editor access.\n " allowBlacklistAccessAndRetrieveReservationsFromPayments: type: boolean description: "Allow access to blacklist and retrieve reservations from the\ \ payment's window.\n " maskBookingContactInformation: type: boolean description: "Mask booking contact information.\n " accessToFlightsWithTrafficRestrictions: type: boolean description: "Access to flights with traffic restrictions.\n " enabledTicketCodes: type: array description: "List of enabled ticket codes. Note: these are only the ticket\ \ codes that are marked\nas true to display the ticket code details. Ticket\ \ codes that are marked false will\nnot be included in this list.\n \ \ " nullable: true items: type: string reservationComments: type: array description: "Pre-defined reservation comments.\n " nullable: true items: type: string itineraryComments: type: array description: "Pre-defined itinerary comments.\n " nullable: true items: type: string manifestComments: type: array description: "Pre-defined manifest comments.\n " nullable: true items: type: string enableDeletePassengerButton: type: boolean description: "Enable delete button on passenger screen.\n " showMultiCityShoppingTabOnAvailabilityRequestScreen: type: boolean description: "Show the Multi City Shopping Tab on the availability request\ \ screen.\n " allowTcpOnDemand: type: boolean description: "Indicates if the user is allowed to send a TCP message.\n\ \ " ManifestViewDateType: type: integer description: "This enumeration represents the manifest view date type.\n \ \ \n\n0 = BookingDate\n1 = SoldDate" x-enumNames: - BookingDate - SoldDate enum: - 0 - 1 PostalCodeLookupType: type: integer description: "This enumeration represents the postal code lookup type.\n \ \ \n\n0 = None\n1 = UsZipCode" x-enumNames: - None - UsZipCode enum: - 0 - 1 IJsonResponseOfSessionSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SessionSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SessionSettings: type: object description: "The session settings.\n " additionalProperties: false properties: sessionTimeOutInterval: type: string description: "The timeout interval for the session.\n " format: duration nullable: true allowApiChannelLogon: type: boolean description: "The flag for allowing the API channel logon.\n " allowDirectChannelLogon: type: boolean description: "The flag for allowing the Direct channel logon.\n \ \ " allowGdsChannelLogon: type: boolean description: "The flag for allowing the GDS channel logon.\n " allowWebChannelLogon: type: boolean description: "The flag for allowing the Web channel logon.\n " IJsonResponseOfLogonSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/LogonSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' LogonSettings: type: object description: "The logon settings.\n " additionalProperties: false properties: allowConsoleReservations: type: boolean description: "A flag that allows logon for the connected Console application.\n\ \ " allowDepartureControlSystem: type: boolean description: "A flag that allows logon through the Departure Control System.\n\ \ " allowWebReporting: type: boolean description: "A flag that allows logon for the connected web reporting application.\n\ \ " allowWebReservations: type: boolean description: "A flag that allows logon for the connected web reservations\ \ application.\n " allowWebServicesApi: type: boolean description: "A flag that allows logon for the connected web services API.\n\ \ " allowExternalSystemServices: type: boolean description: "A flag that allows logon for the connected web services through\ \ an External System Communication.\n " allowWindowsFareManager: type: boolean description: "A flag that allows logon for the Fare Manager application.\n\ \ " allowWindowsManager: type: boolean description: "A flag that allows logon for the Manager application.\n \ \ " allowWindowsReservations: type: boolean description: "A flag that allows login for the Reservations application.\n\ \ " allowWindowsScheduleManager: type: boolean description: "A flag that allows login for the Schedule Manager application.\n\ \ " impersonationRoles: type: array description: "A list of acceptable impersonation roles for this role.\n\ \ " nullable: true items: type: string overrideSystemAccessRestriction: type: boolean description: "A flag that allows overriding the system access restrictions.\n\ \ " allowDotRezCenter: type: boolean description: "A flag that indicates whether log-ons to dotREZ Center are\ \ allowed.\n " IJsonResponseOfCodesSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CodesSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CodesSettings: type: object description: "The codes settings.\n " additionalProperties: false properties: allowedPaymentMethodsForFraudPrevention: type: object description: "A dictionary that map payment method codes to a boolean representing\ \ whether it is allowed for fraud\nprevention.\n " nullable: true additionalProperties: type: boolean automaticMoveNestOverbookClasses: type: array description: "A list of classes that automatically move or nest on overbook.\n\ \ " nullable: true items: type: string editableRuleTypes: type: array description: "A list of editable rule types.\n " nullable: true items: type: string externalPaymentValidationOverrides: type: object description: "A list of external payment codes that allow validation overrides.\n\ \ " nullable: true additionalProperties: type: boolean overrideFeeTypes: type: array description: "A list of fee types that allow overrides. = ['All', 'Tax',\ \ 'TravelFee', 'ServiceFee', 'PaymentFee', 'PenaltyFee',\n'SsrFee', 'NonFlightServiceFee',\ \ 'UpgradeFee', 'SeatFee', 'BaseFare', 'SpoilageFee', 'NameChangeFee',\n\ 'ConvenienceFee', 'BaggageFee', 'FareSurcharge', 'PromotionDiscount']\n\ \ " nullable: true items: $ref: '#/components/schemas/FeeType' paymentFieldOverrides: type: object description: "A dictionary that map payment codes with a dictionary mapping\ \ payment fields to their requirement\nrules.\n " nullable: true additionalProperties: type: object additionalProperties: $ref: '#/components/schemas/RequiredType' privateTravelQueueCategory: description: "The permissions allowed on the private travel queue category\ \ for this role.\n " $ref: '#/components/schemas/QueueCategoriesAccessControl' publicTravelQueueCategory: description: "The permissions allowed on the public travel queue category\ \ for this role.\n " $ref: '#/components/schemas/QueueCategoriesAccessControl' refundablePaymentMethodCodes: type: array description: "A list of payment codes that allow refunds.\n " nullable: true items: type: string spoilFeeTypes: type: array description: "A list of fee types that are Spoilage Fees. = ['All', 'Tax',\ \ 'TravelFee', 'ServiceFee', 'PaymentFee', 'PenaltyFee',\n'SsrFee', 'NonFlightServiceFee',\ \ 'UpgradeFee', 'SeatFee', 'BaseFare', 'SpoilageFee', 'NameChangeFee',\n\ 'ConvenienceFee', 'BaggageFee', 'FareSurcharge', 'PromotionDiscount']\n\ \ " nullable: true items: $ref: '#/components/schemas/FeeType' classOfServices: type: array description: "A list of allowed classes of service.\n " nullable: true items: type: string depositPaymentTypes: type: array description: "A list of allowed payment codes that are deposit payment types.\n\ \ " nullable: true items: type: string fareTypes: type: array description: "A list of allowed fare types.\n " nullable: true items: type: string passengerDiscountCodes: type: array description: "A list of allowed passenger discount codes.\n " nullable: true items: type: string passengerTypeCodes: type: array description: "A list of allowed passenger types.\n " nullable: true items: type: string paymentMethodCodes: type: array description: "A list of allowed payment method codes.\n " nullable: true items: type: string penaltyFeeCodes: type: array description: "A list of penalty fee codes.\n " nullable: true items: type: string productClasses: type: array description: "A list of allowed product classes.\n " nullable: true items: type: string queueCategoryCodes: type: object description: "A dictionary that maps queue category codes.\n " nullable: true additionalProperties: type: integer format: int32 sellSsrCodes: type: array description: "The allowed sell SSR Codes.\n " nullable: true items: type: string serviceFeeCodes: type: array description: "The allowed service fee codes.\n " nullable: true items: type: string standbyClassOfServiceCodes: type: array description: "The class of services that are allowed standby.\n \ \ " nullable: true items: type: string stationCategories: type: array description: "The allowed station categories.\n " nullable: true items: type: string viewableSeatProperties: type: array description: "The list viewable seat properties.\n " nullable: true items: type: string waiveFeeTypes: type: array description: "The fee types that allow waiving. = ['All', 'Tax', 'TravelFee',\ \ 'ServiceFee', 'PaymentFee', 'PenaltyFee', 'SsrFee',\n'NonFlightServiceFee',\ \ 'UpgradeFee', 'SeatFee', 'BaseFare', 'SpoilageFee', 'NameChangeFee',\ \ 'ConvenienceFee',\n'BaggageFee', 'FareSurcharge', 'PromotionDiscount']\n\ \ " nullable: true items: $ref: '#/components/schemas/FeeType' defaultFareType: type: string description: "The default fare type set in the availability screen.\n \ \ " nullable: true QueueCategoriesAccessControl: type: integer description: "This enumeration represents the permission levels for managing\ \ queue categories.\n \n\n0 = None\n1 = View\n2 = All" x-enumNames: - None - View - All enum: - 0 - 1 - 2 IJsonResponseOfItinerarySettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ItinerarySettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ItinerarySettings: type: object description: "Settings for the premium services.\n " additionalProperties: false properties: allowDivideEmailUpdate: type: boolean description: "Indicates if the user is allowed to specify/update the contact\ \ email of both the original\nand the new bookings during the divide process.\n\ \ " sendItineraryOnHeldBookings: type: boolean description: "Indicates if an itinerary notification will be sent for a\ \ booking with a hold.\n " sendItineraryOnHeldCancelledBookings: type: boolean description: "Indicates if an itinerary notification will be sent for a\ \ held-cancelled booking.\n " sendItineraryOnPartiallyPaidBookings: type: boolean description: "Indicates if an itinerary notification will be sent for a\ \ partially paid booking.\n " IJsonResponseOfOrganizationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/OrganizationSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' OrganizationSettings: type: object description: "Settings for the organization.\n " additionalProperties: false properties: companyTimeZone: type: string description: "The time zone that the airline headquarters is located in.\n\ \ " nullable: true IJsonResponseOfExternalMessageControls: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ExternalMessageControls' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ExternalMessageControls: type: object description: "Settings for external messaging.\n " additionalProperties: false properties: carrierCodes: type: array description: "List of carrier codes from the e-ticket database.\n \ \ " nullable: true items: type: string IJsonResponseOfTravelerNotificationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/TravelerNotificationSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TravelerNotificationSettings: type: object description: "Settings for traveler notification.\n " additionalProperties: false properties: allowBookingLevelRequest: type: boolean description: "Indicates if the booking-level setting on notification delivery\ \ methods is enabled.\nIf enabled, the passengers can request notifications\ \ (via email or SMS) without having a New Skies customer\nprofile.\n \ \ " IJsonResponseOfServiceBundlesSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ServiceBundlesSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ServiceBundlesSettings: type: object description: "Defines the settings for service bundles.\n " additionalProperties: false properties: allowRemovalOfCommittedAddOnBundles: type: boolean description: "Indicates if agents are allowed to remove committed add-on\ \ bundles.\n " IJsonResponseOfGeneralNotificationsSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/GeneralNotificationsSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' GeneralNotificationsSettings: type: object description: "Settings for general New Skies notifications.\n " additionalProperties: false properties: enableTicketControlNumberNotifications: type: boolean description: "If set to true, Ticket Control Number (TCN) notifications\ \ will be sent to the Sales Data Interchange and\nSkyLedger plug-ins.\n\ \ " IJsonResponseOfGeneralSystemSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/GeneralSystemSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' GeneralSystemSettings: type: object description: "The general system settings.\n " additionalProperties: false properties: manageFYIContent: description: "The allowed access control for managing FYI content.\n \ \ " $ref: '#/components/schemas/AccessControl' manageGeneralReferenceManagement: description: "The allowed access control for managing contents.\n \ \ " $ref: '#/components/schemas/AccessControl' allowAccessToFyiContent: type: boolean description: "Indicates whether access to FYI content dialog or application\ \ is allowed.\n " manageQueues: description: "The allowed access control for managing queues.\n \ \ " $ref: '#/components/schemas/AccessControl' allowAgentToEmptyBookingQueues: type: boolean description: "Indicates whether agents with access to manage queues (set\ \ to `All`) are allowed to empty booking queues.\n " IJsonResponseOfIListOfAccountTransactionCode: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/AccountTransactionCode' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AccountTransactionCode: type: object description: "The account transaction code model.\n " additionalProperties: false required: - transactionCode properties: transactionCode: type: string description: "The unique transaction code.\n " maxLength: 6 minLength: 0 name: type: string description: "The Name.\n " maxLength: 64 minLength: 0 nullable: true expirationType: description: "The expiration type.\n " $ref: '#/components/schemas/CreditExpirationType' expirationDays: type: integer description: "The expiration days.\n " expirationDate: type: string description: "The expiration date.\n " format: date-time nullable: true inActive: type: boolean description: "In active.\n " CreditExpirationType: type: integer description: "Credit expiration type enumeration.\n \n\n0 = None\n\ 1 = FixedAtIssuance\n2 = FixedDate\n3 = FixedAtBooking" x-enumNames: - None - FixedAtIssuance - FixedDate - FixedAtBooking enum: - 0 - 1 - 2 - 3 IJsonResponseOfAccountTransactionCode: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AccountTransactionCode' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfAddressType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/AddressType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AddressType: type: object description: "The Address Type\n " additionalProperties: false required: - addressTypeCode properties: addressTypeCode: type: string description: "The address type code.\nPlease note that this should be a\ \ char and not a string.\n " maxLength: 1 minLength: 1 name: type: string description: "The name of the address type.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The InActive of Address type.\n " IJsonResponseOfAddressType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AddressType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfStation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Station' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Station: type: object description: "Defines a station.\n " additionalProperties: false required: - stationCode properties: stationCode: type: string description: "The station unique code.\n " maxLength: 3 minLength: 0 inActive: type: boolean description: "The flag indicating if the station is inactive.\n \ \ " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes\ \ endpoint to verify role based access instead.\n " icaoCode: type: string description: "The International Civil Aviation Organization (ICAO) code\ \ for the station.\n " nullable: true fullName: type: string description: "The full display name.\n " maxLength: 64 minLength: 0 nullable: true shortName: type: string description: "The short display name.\n " nullable: true macCode: type: string description: "The stations MAC (multiple airport code) code.\n \ \ " nullable: true currencyCode: type: string description: "The stations default currency code.\n " maxLength: 3 minLength: 0 nullable: true conversionCurrencyCode: type: string description: "The stations configured conversion currency code.\n \ \ " maxLength: 3 minLength: 0 nullable: true cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 nullable: true class: type: string description: "The stations configured class.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 locationDetails: description: "The stations location details.\n " nullable: true $ref: '#/components/schemas/StationLocationDetails' StationLocationDetails: type: object description: "Defines the station location details.\n " additionalProperties: false properties: coordinates: description: "The coordinates of the station.\n " nullable: true $ref: '#/components/schemas/Coordinate' zoneCode: type: string description: "The geographical location code (i.e. North America, Europe).\n\ \ " nullable: true subZoneCode: type: string description: "The sub zone code based on the geographical location (i.e.\ \ USA, Canada).\n " nullable: true countryCode: type: string description: "The country code the station exists in.\n " nullable: true provinceStateCode: type: string description: "The province or state the station exists in.\n " nullable: true cityCode: type: string description: "The city the station exists in.\n " nullable: true timeZoneCode: type: string description: "The configured timezone of the station.\n " nullable: true thirdPartyControlled: type: boolean description: "The flag indicating if the station is controlled via a third\ \ party.\n " customsRequiredForCrew: type: boolean description: "The flag indicating if customs is required for crew members.\n\ \ " weightType: description: "The stations configured weight units of measurement.\n \ \ " $ref: '#/components/schemas/WeightType' IJsonResponseOfStationDetail: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/StationDetail' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' StationDetail: type: object description: "Defines station details.\n " additionalProperties: false properties: categories: type: array description: "The station categories by category code. If empty all categories\ \ are supported.\nPlease note that this should be a list of chars and\ \ not a list of strings.\n " nullable: true items: type: string maxLength: 1 feeZones: type: array description: "The fee zones by code.\n " nullable: true items: type: string IJsonResponseOfIListOfArea: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Area' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Area: type: object description: "The area model.\n " additionalProperties: false properties: areaCode: type: string description: "Gets or sets the code for this area.\n " maxLength: 3 minLength: 1 nullable: true description: type: string description: "Gets or sets the description of this area.\n " maxLength: 128 minLength: 0 nullable: true name: type: string description: "Gets or sets the name of this area.\n " maxLength: 64 minLength: 0 nullable: true zones: type: array description: "Gets or sets the list of zones associated with this area.\n\ \ " nullable: true items: $ref: '#/components/schemas/Zone' Zone: type: object description: "The zone model.\n " deprecated: true x-deprecatedMessage: 4.4.1 - Please use Zonev2 instead. additionalProperties: false required: - areaCode - zoneCode properties: areaCode: type: string description: "Gets or sets the area code of this zone.\n " maxLength: 3 minLength: 1 name: type: string description: "Gets or sets the name of this zone.\n " maxLength: 64 minLength: 0 nullable: true zoneCode: type: string description: "Gets or sets the zone code of this zone.\n " maxLength: 2 minLength: 1 subZones: type: array description: "Gets or sets the list of subzones associated with this zone.\n\ \ " nullable: true items: $ref: '#/components/schemas/SubZone' SubZone: type: object description: "The subzone model.\n " deprecated: true x-deprecatedMessage: 4.4.1 - Please use SubZonev2 instead. additionalProperties: false required: - subZoneCode - zoneCode - areaCode properties: name: type: string description: "Gets or sets the name of this subzone.\n " maxLength: 64 minLength: 0 nullable: true subZoneCode: type: string description: "Gets or sets the subzone code for this subzone.\n \ \ " maxLength: 3 minLength: 1 zoneCode: type: string description: "Gets or sets the zone code for this subzone.\n " maxLength: 2 minLength: 1 areaCode: type: string description: "Gets or sets the area code for this subzone.\n " maxLength: 3 minLength: 1 stations: type: array description: "Gets or sets the list of stations associated with this subzone.\n\ \ " nullable: true items: $ref: '#/components/schemas/Station' IJsonResponseOfArea: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Area' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfBaggageType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BaggageType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BaggageType: type: object description: "The baggage type model.\n " additionalProperties: false required: - baggageTypeCode properties: baggageTypeCode: type: string description: "Gets or sets the baggage type code.\n " maxLength: 6 minLength: 1 bagWeightType: description: "Gets or sets the bag weight type.\n " $ref: '#/components/schemas/WeightType' freeBag: type: boolean description: "Gets or sets the free bag flag.\n " inActive: type: boolean description: "Gets or sets the inactive flag.\n " name: type: string description: "Gets or sets the name of the baggage type.\n " maxLength: 64 minLength: 0 nullable: true weightReducedBy: type: integer description: "Gets or sets the weight reduced by value.\n " maximum: 999.0 minimum: 0.0 includeInBaggageCount: type: boolean description: "Indicates if the baggage type will be displayed in the GoNow\ \ baggage count.\n " IJsonResponseOfBaggageType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BaggageType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfCity: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/City' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' City: type: object description: "The city model.\n " additionalProperties: false properties: cityCode: type: string description: "Gets or sets the code for this city.\n " maxLength: 3 minLength: 1 nullable: true countryCode: type: string description: "Gets or sets the country code for this city\n " maxLength: 2 minLength: 1 nullable: true inActive: type: boolean description: "Gets or sets the inactive flag for this city.\n \ \ " name: type: string description: "Gets or sets the name for this city\n " maxLength: 64 minLength: 0 nullable: true provinceStateCode: type: string description: "Gets or sets the province/state code for this city.\n \ \ " maxLength: 3 minLength: 1 nullable: true shortName: type: string description: "Gets or sets the short name for this city.\n " maxLength: 32 minLength: 0 nullable: true IJsonResponseOfCity: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/City' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfClassOfService: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ClassOfService' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ClassOfService: type: object description: "The class of service model.\n " additionalProperties: false properties: classOfServiceCode: type: string description: "The class of service code.\n " maxLength: 8 minLength: 0 nullable: true name: type: string description: "The Name.\n " maxLength: 64 minLength: 0 nullable: true shortName: type: string description: "The short name.\n " maxLength: 32 minLength: 0 nullable: true nonRevenue: type: boolean description: "The non revenue.\n " traceQueueCode: type: string description: "The trace queue code.\n " maxLength: 6 minLength: 0 nullable: true gdsBookingOnly: type: boolean description: "The GDS booking only.\n " upgrade: type: boolean description: "Indicates if the class of service is used for upgrades.\n\ \ " inActive: type: boolean description: "The in active.\n " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes\ \ endpoint to verify role based access instead.\n " standByAllowed: type: boolean description: "The stand by allowed.\n " seatGroup: type: integer description: "The seat group.\n " downgrade: type: boolean description: "Indicates if the class of service is used for downgrades.\n\ \ " IJsonResponseOfClassOfService: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ClassOfService' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfDelay: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Delay' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Delay: type: object description: "The delay model.\n " additionalProperties: false properties: delayCode: type: string description: "The delay code.\n " nullable: true delayType: description: "The delay type.\n " $ref: '#/components/schemas/DelayType' name: type: string description: "The Name.\n " nullable: true inActive: type: boolean description: "The InActive of Delay.\n " DelayType: type: integer description: "DelayType\n \n\n0 = Unknown\n1 = AirlineInternalCodes\n\ 2 = Others\n3 = Schedules\n4 = PassengerAndBaggage\n5 = CargoAndMail\n6 =\ \ MailOnly\n7 = AircraftAndRampHandling\n8 = TechnicalAndAircraftEquipment\n\ 9 = DamageToAircraft\n10 = EdpAutomatedEquipmentFailure\n11 = FlightOperationsAndCrewing\n\ 12 = Weather\n13 = AirTrafficFlowManagement\n14 = AirportAndGovernmentalAuthorities\n\ 15 = Reactionary\n16 = Miscellaneous" x-enumNames: - Unknown - AirlineInternalCodes - Others - Schedules - PassengerAndBaggage - CargoAndMail - MailOnly - AircraftAndRampHandling - TechnicalAndAircraftEquipment - DamageToAircraft - EdpAutomatedEquipmentFailure - FlightOperationsAndCrewing - Weather - AirTrafficFlowManagement - AirportAndGovernmentalAuthorities - Reactionary - Miscellaneous enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 IJsonResponseOfDelay: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Delay' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfExternalRate: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ExternalRate' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfExternalRate: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ExternalRate' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfExternalSystem: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ExternalSystem' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ExternalSystem: type: object description: "The external system model.\n " additionalProperties: false properties: systemCode: type: string description: "The code for this external system.\n " maxLength: 3 minLength: 0 nullable: true name: type: string description: "The name for this external system.\n " maxLength: 64 minLength: 0 nullable: true IJsonResponseOfIListOfFareDiscount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/FareDiscount' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareDiscount: type: object description: "The fare discount model.\n " additionalProperties: false properties: fareDiscountCode: type: string description: "The fare discount code.\n " nullable: true name: type: string description: "The fare discount name.\n " nullable: true fareDiscountAmounts: type: array description: "The fare discount amounts.\n " nullable: true items: $ref: '#/components/schemas/FareDiscountAmount' inActive: type: boolean description: "The inactive flag.\n " discountPercent: type: number description: "The discount percent.\n " format: decimal FareDiscountAmount: type: object description: "The fare discount amount model.\n " additionalProperties: false properties: fareDiscountCode: type: string description: "The fare discount code.\n " nullable: true currencyCode: type: string description: "The currency code.\n " nullable: true discountAmount: type: number description: "The discount amount.\n " format: decimal IJsonResponseOfFareDiscount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FareDiscount' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfFareSurcharge: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/FareSurcharge' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareSurcharge: type: object description: "The fare surcharge model.\n " additionalProperties: false properties: fareSurchargeCode: type: string description: "The fare surcharge code.\n " nullable: true name: type: string description: "The fare surcharge name.\n " nullable: true displayCode: type: string description: "The display code.\n " nullable: true defaultCurrencyCode: type: string description: "The default currency code.\n " nullable: true taxApplication: description: "The tax application.\n " $ref: '#/components/schemas/TaxApplication' fareSurchargeAmounts: type: array description: "The fare surcharge amount list.\n " nullable: true items: $ref: '#/components/schemas/FareSurchargeAmount' inActive: type: boolean description: "The inactive flag.\n " percent: type: number description: "The percent.\n " format: decimal FareSurchargeAmount: type: object description: "The fare surcharge amount model.\n " additionalProperties: false properties: fareSurchargeCode: type: string description: "The fare surcharge code.\n " nullable: true currencyCode: type: string description: "The currency code.\n " nullable: true amount: type: number description: "The amount.\n " format: decimal IJsonResponseOfFareSurcharge: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FareSurcharge' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfFareType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/FareType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FareType: type: object description: "The fare type model.\n " additionalProperties: false required: - fareTypeCode properties: fareTypeCode: type: string description: "The fare type code.\n " minLength: 1 name: type: string description: "The name.\n " nullable: true inActive: type: boolean description: "Is active.\n " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes\ \ endpoint to verify role based access instead.\n " IJsonResponseOfFareType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FareType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Fee' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Fee: type: object description: "Fee Model.\n " additionalProperties: false properties: canBeManuallyAdded: type: boolean description: "Returns true if this fee can be manually added.\n \ \ " hasDefaultFeePrice: type: boolean description: "Returns true if this fee can be queried to check the default\ \ price.\n " isFeeChargedPerSegment: type: boolean description: "Returns true if the given fee code is charged per segment/leg.\n\ \ " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes\ \ endpoint to verify role based access instead.\n " chargeLimit: type: integer description: "Gets or sets the charge limit of this fee.\n " maximum: 32767.0 minimum: 0.0 chargeLimitMode: description: "Gets or sets when the charge limit is applied to this fee.\n\ \ " $ref: '#/components/schemas/ChargeLimitMode' chargeLimitTravelComponent: description: "Gets or sets the charge limit for the travel component associated\ \ with this fee.\n " $ref: '#/components/schemas/TravelComponent' commissionable: type: boolean description: "Gets or sets the commissionable flag for this fee.\n \ \ " countryCode: type: string description: "Gets or sets the country code for this fee.\n " maxLength: 2 minLength: 0 nullable: true description: type: string description: "Gets or sets the description for this fee.\n " maxLength: 128 minLength: 0 nullable: true displayCode: type: string description: "Gets or sets the display code for this fee.\n " maxLength: 3 minLength: 0 nullable: true feeApplication: description: "Gets or sets how this fee is applied.\n " $ref: '#/components/schemas/FeeApplication' feeCode: type: string description: "Gets or sets the code for this fee.\n " maxLength: 6 minLength: 0 nullable: true feeOptionMode: description: "Gets or sets the fee option mode for this fee.\n \ \ " $ref: '#/components/schemas/FeeOptionMode' feeType: description: "Gets or sets the fee type for this fee.\n " $ref: '#/components/schemas/FeeType' inActive: type: boolean description: "Gets or sets the inactive flag for this fee.\n " itemizable: type: boolean description: "Gets or sets the itemizable flag for this fee.\n \ \ " minStopover: type: integer description: "Gets or sets the MinStopover of this fee.\n " maximum: 32767.0 minimum: 0.0 minStopoverInternational: type: integer description: "Gets or sets the International MinStopover of this fee.\n\ \ " maximum: 32767.0 minimum: 0.0 name: type: string description: "Gets or sets the name of this fee.\n " maxLength: 64 minLength: 0 nullable: true taxApplication: description: "Gets or sets how the taxes are applied for this fee.\n \ \ " $ref: '#/components/schemas/TaxApplication' ticketable: type: boolean description: "Gets or sets the ticketable flag for this fee.\n \ \ " travelComponent: description: "Gets or sets the travel component associated with this fee.\n\ \ " $ref: '#/components/schemas/TravelComponent' ChargeLimitMode: type: integer description: "Enumeration representing the mode when the charge limit is applied.\n\ \ \n\n0 = FirstOccurrences\n1 = LastOccurrences\n2 = FirstOutLastInOccurrences" x-enumNames: - FirstOccurrences - LastOccurrences - FirstOutLastInOccurrences enum: - 0 - 1 - 2 FeeOptionMode: type: integer description: "Enumeration for different modes for fee options.\n \ \ \n\n0 = Default\n1 = All\n2 = LowestCost\n3 = HighestCost" x-enumNames: - Default - All - LowestCost - HighestCost enum: - 0 - 1 - 2 - 3 IJsonResponseOfFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Fee' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfHotCardReason: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/HotCardReason' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' HotCardReason: type: object description: "The hot card reason model.\n " additionalProperties: false required: - hotCardReasonCode properties: hotCardReasonCode: type: string description: "The reason code.\n " maxLength: 4 minLength: 0 name: type: string description: "The name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The in active.\n " IJsonResponseOfHotCardReason: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/HotCardReason' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfIssuanceReason: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/IssuanceReason' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IssuanceReason: type: object description: "The issuance reason model.\n " additionalProperties: false required: - issuanceReasonCode properties: issuanceReasonCode: type: string description: "The reason code.\n " maxLength: 4 minLength: 0 name: type: string description: "The name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The in active.\n " IJsonResponseOfIssuanceReason: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/IssuanceReason' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfLocation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Location' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Location: type: object description: "The location model.\n " additionalProperties: false properties: locationCode: type: string description: "The Location Code.\n " maxLength: 5 minLength: 0 nullable: true name: type: string description: "The Name.\n " maxLength: 64 minLength: 0 nullable: true locationType: description: "The location type.\n " $ref: '#/components/schemas/LocationType' paymentGroupId: type: integer description: "The payment group id.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 1 nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 1 nullable: true inActive: type: boolean description: "The in active.\n " LocationType: type: integer description: "The location type enumeration.\n \n\n0 = Other\n1 =\ \ Station\n2 = City" x-enumNames: - Other - Station - City enum: - 0 - 1 - 2 IJsonResponseOfLocation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Location' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfMac: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Mac' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Mac: type: object description: "The MAC station model defines areas of related stations by region.\ \ //todo: Document and expand the MAC acronym\n " additionalProperties: false required: - macCode - name properties: inActive: type: boolean description: "The inactive flag for this MAC station.\n " macCode: type: string description: "The code for this MAC station.\n " maxLength: 3 minLength: 1 macStations: type: array description: "The stations associated with this MAC.\n " nullable: true items: type: string name: type: string description: "The name for this MAC.\n " maxLength: 64 minLength: 1 IJsonResponseOfIListOfMarketRoute: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/MarketRoute' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' MarketRoute: type: object description: "Defines a market route.\n " additionalProperties: false properties: arrivalStation: type: string description: "The route arrival station.\n " maxLength: 3 minLength: 3 nullable: true departureStation: type: string description: "The route departure station.\n " maxLength: 3 minLength: 3 nullable: true connectionMarketSegments: type: array description: "The list of segments that comprise this route, in order.\n\ \ " nullable: true items: $ref: '#/components/schemas/MarketSegment' MarketSegment: type: object description: "The market model.\n " additionalProperties: false properties: departureStation: type: string description: "The departure station of the segment.\n " maxLength: 3 minLength: 3 nullable: true arrivalStation: type: string description: "The arrival station of the segment.\n " maxLength: 3 minLength: 3 nullable: true segmentNumber: type: integer description: "The sequence number for this segment.\n " IJsonResponseOfIListOfMessageType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/MessageType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' MessageType: type: object description: "The message type model.\n " additionalProperties: false required: - messageTypeCode properties: messageTypeCode: type: string description: "The reason code.\n " maxLength: 4 minLength: 0 name: type: string description: "The name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The in active.\n " IJsonResponseOfMessageType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/MessageType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPaymentMethod: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PaymentMethod' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPaymentMethod: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PaymentMethod' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfResourcePostalCodeResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ResourcePostalCodeResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ResourcePostalCodeResponse: type: object description: "Model representing the resource postal code response.\n \ \ " additionalProperties: false properties: postalCodes: type: array description: "The list of postal codes.\n " nullable: true items: $ref: '#/components/schemas/PostalCode' totalCount: type: integer description: "The total count of all postal codes.\n " format: int32 lastPageKey: type: string description: "Used to specify the last item of the page of the last set\ \ of records retrieved\nwhen paging was performed.\n " nullable: true PostalCode: type: object description: "The postal code model.\n " additionalProperties: false required: - countryCode - provinceStateCode properties: code: type: string description: "The postal code.\n " maxLength: 10 minLength: 1 nullable: true cityName: type: string description: "The city name for this postal code.\n " maxLength: 64 minLength: 0 nullable: true countryCode: type: string description: "The two-digit country code for this postal code.\n \ \ " maxLength: 2 minLength: 1 provinceStateCode: type: string description: "The province state code for this postal code.\n \ \ " maxLength: 3 minLength: 1 IJsonResponseOfPostalCode: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PostalCode' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfProductClass: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ProductClass' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ProductClass: type: object description: "The product class model.\n " additionalProperties: false properties: productClassCode: type: string description: "The product class.\n " maxLength: 2 minLength: 1 nullable: true name: type: string description: "The name.\n " maxLength: 64 minLength: 0 nullable: true rank: type: integer description: "The rank.\n " maximum: 999.0 minimum: 0.0 inActive: type: boolean description: "The in active.\n " IJsonResponseOfProductClass: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ProductClass' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPromotionSettingType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PromotionSettingType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PromotionSettingType: type: object description: "The promotion setting type model.\n " additionalProperties: false required: - promotionSettingTypeCode properties: promotionSettingTypeCode: type: string description: "The promotion setting type code.\n " minLength: 1 name: type: string description: "The setting type name.\n " nullable: true inActive: type: boolean description: "In active\n " schema: type: string description: "The data schema.\n " maxLength: 2147483647 minLength: 0 nullable: true IJsonResponseOfPromotionSettingType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PromotionSettingType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfProvinceState: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ProvinceState' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ProvinceState: type: object description: "The province/state code model.\n " additionalProperties: false required: - provinceStateCode - countryCode properties: cities: type: array description: "Gets or sets the list of cities associated with this province/state\n\ \ " nullable: true items: $ref: '#/components/schemas/City' provinceStateCode: type: string description: "Gets or sets the code of the province/state.\n " maxLength: 3 minLength: 1 name: type: string description: "Gets or sets the Name of the province/state.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "Gets or sets the inactive flag of the province/state.\n \ \ " countryCode: type: string description: "Gets or sets the country code of the province/state.\n \ \ " maxLength: 2 minLength: 1 IJsonResponseOfProvinceState: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ProvinceState' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfReminderTime: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ReminderTime' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ReminderTime: type: object description: "The reminder time for a notification timed event.\n \ \ " additionalProperties: false properties: type: description: "The notification timed event type.\n " $ref: '#/components/schemas/NotificationTimedEventType' times: type: array description: "The list of acceptable reminder times.\n " nullable: true items: type: integer format: int32 IJsonResponseOfReminderTime: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ReminderTime' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfCheckInSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CheckInSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CheckInSettings: type: object description: "The Booking Check-In Settings.\n " additionalProperties: false properties: allowApisCheckIn: description: "Gets or sets the APIS rules for Check-In.\n " $ref: '#/components/schemas/ApisCheckInType' allowIappCheckIn: description: "Gets or sets the IAPP rules for Check-In.\n " $ref: '#/components/schemas/IappCheckInType' domesticBagWeight: description: "Gets or sets the Domestic bag weight rules for Check-In.\n\ \ " $ref: '#/components/schemas/BagWeightControl' internationalBagWeight: description: "Gets or sets the International bag weight rules for Check-In.\n\ \ " $ref: '#/components/schemas/BagWeightControl' allowAppsCheckIn: type: boolean description: "Gets or sets the flag to allow APPS Checkin.\n " allowAppsOverride: type: boolean description: "Gets or sets the flag to allow APPS override in Check-In.\n\ \ " allowBagTagDestinationMismatch: type: boolean description: "Gets or sets the allow bag tag destination mismatch flag for\ \ Check-In.\n " allowBagTagReprint: type: boolean description: "Gets or sets the flag to allow reprinting bag tags for Check-In.\n\ \ " allowCheckedInPassengerFlightChange: type: boolean description: "Gets or sets the flag that allows checked-in passenger to\ \ change flight for Check-In.\n " allowCheckedInPassengerNameChange: type: boolean description: "Gets or sets the flag that allows checked-in passenger to\ \ change name for Check-In.\n " allowCheckInOfPassengerWithPendingPayments: type: boolean description: "Gets or sets the flag that allows a passenger with pending\ \ payments to check-in.\n " allowCheckInWhenTicketCollected: type: boolean description: "Gets or sets the flag that allows a passenger to check-in\ \ when ticket is collected for Check-In.\n " allowETicketCouponStatusOverride: type: boolean description: "Gets or sets the status override flag for allowing an E-Ticket\ \ coupon for Check-In.\n " allowGatePassPrinting: type: boolean description: "Gets or sets the flag for allowing the gate info to be printed\ \ for Check-In.\n " allowInvalidBookingCheckIn: type: boolean description: "Gets or sets the flag for allowing an invalid booking to be\ \ checked-in.\n " allowManualClearance: type: boolean description: "Gets or sets the flag for allowing manual clearance IN OUTAGE\ \ MODE for Check-In.\n " allowMidJourneyCheckIn: type: boolean description: "Gets or sets the flag for allowing mid-journey Check-In.\n\ \ " allowTbaCheckIn: type: boolean description: "Gets or sets the flag allowing a passenger with the name TBA\ \ to be allowed to check-in.\n " ignoreMarketTimeRestrictions: type: boolean description: "Gets or sets the flag allowing to ignore market time restrictions\ \ for Check-In.\n " checkedInPassengerFlightChangeOffset: type: string description: "Gets or sets the timespan a checked-in passenger can change\ \ flights.\n " format: duration nullable: true checkedInPassengerNameChangeOffset: type: string description: "Gets or sets the timespan a checked-in passenger can change\ \ names.\n " format: duration nullable: true checkedInCloseOffset: type: string description: "Gets or sets the timespan a passengers opportunity to check-in\ \ closes prior to flight.\n " format: duration nullable: true checkedInOpenOffset: type: string description: "Gets or sets the timespan a passengers opportunity to check-in\ \ opens prior to flight.\n " format: duration nullable: true allowedSsrCodes: type: array description: "Gets or sets a collection of allowed SSR codes for Check-In\ \ reference.\n " nullable: true items: type: string restrictedSsrCodes: type: array description: "Gets or sets a collection of restricted SSR codes for Check-In\ \ reference.\n " nullable: true items: type: string requiredSsrCodes: type: array description: "Gets or sets a collection of required SSR codes for Check-In\ \ reference.\n " nullable: true items: type: string allowManualClearanceInNormalMode: type: boolean description: "Gets or sets the flag for allowing manual clearance IN NORMAL\ \ MODE for Check-In.\n " ApisCheckInType: type: integer description: "Enumeration of APIS Check-in rules.\n \n\n0 = NotAllowed\n\ 1 = AllowedWithVerifiedDocument\n2 = AllowedWithDocument\n3 = AllowedWithoutVerifiedDocument" x-enumNames: - NotAllowed - AllowedWithVerifiedDocument - AllowedWithDocument - AllowedWithoutVerifiedDocument enum: - 0 - 1 - 2 - 3 IappCheckInType: type: integer description: "Enumeration of IAPP Check-in rules.\n \n\n0 = NotAllowed\n\ 1 = AllowedWithVerifiedDocument\n2 = AllowedWithDocument\n3 = AllowedWithoutVerifiedDocument" x-enumNames: - NotAllowed - AllowedWithVerifiedDocument - AllowedWithDocument - AllowedWithoutVerifiedDocument enum: - 0 - 1 - 2 - 3 BagWeightControl: type: integer description: "Enumeration for Bag weight rules.\n \n\n0 = WeightNotRequired\n\ 1 = TotalWeightRequired\n2 = IndividualWeightRequired" x-enumNames: - WeightNotRequired - TotalWeightRequired - IndividualWeightRequired enum: - 0 - 1 - 2 IJsonResponseOfContactSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ContactSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ContactSettings: type: object description: "The booking contact settings.\n " additionalProperties: false properties: title: description: "Title field validation control.\n " $ref: '#/components/schemas/FieldControlType' firstName: description: "First name field validation control.\n " $ref: '#/components/schemas/FieldControlType' middleName: description: "Middle name field validation control.\n " $ref: '#/components/schemas/FieldControlType' lastName: description: "Last name field validation control.\n " $ref: '#/components/schemas/FieldControlType' suffix: description: "Suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' addressLineOne: description: "Address line one field validation control.\n " $ref: '#/components/schemas/FieldControlType' addressLineTwo: description: "Address line two field validation control.\n " $ref: '#/components/schemas/FieldControlType' addressLineThree: description: "Address line three field validation control.\n " $ref: '#/components/schemas/FieldControlType' city: description: "Address city field validation control.\n " $ref: '#/components/schemas/FieldControlType' state: description: "Address state field validation control.\n " $ref: '#/components/schemas/FieldControlType' postalCode: description: "Address postal code field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' country: description: "Address country field validation control.\n " $ref: '#/components/schemas/FieldControlType' email: description: "Email field validation control.\n " $ref: '#/components/schemas/FieldControlType' homePhoneNumber: description: "Home phone number field validation control.\n " $ref: '#/components/schemas/FieldControlType' workPhoneNumber: description: "Work phone number field validation control.\n " $ref: '#/components/schemas/FieldControlType' otherPhoneNumber: description: "Other phone number field validation control.\n " $ref: '#/components/schemas/FieldControlType' faxNumber: description: "Fax number field validation control.\n " $ref: '#/components/schemas/FieldControlType' disablePhoneFormat: type: boolean description: "Flag indicating to disable phone number formatting.\n \ \ " defaultItineraryDistribution: description: "The default itinerary distribution option.\n " $ref: '#/components/schemas/DistributionOption' notificationPreference: description: "Notification preference field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' defaultNotificationPreference: description: "The default notification preference.\n " $ref: '#/components/schemas/NotificationPreference' defaultToCustomerPreference: type: boolean description: "Flag indicating to default the customer preferences to the\ \ contact.\n " maskContactLanguage: type: boolean description: "Gets or Sets the indicator whether contact language is masked.\n\ \ " maskIndiaGSTInfo: type: boolean description: "Gets or Sets the indicator whether contact language is masked.\n\ \ " FieldControlType: type: integer description: "Defines the different field validation types.\n \n\n\ 0 = Required\n1 = Optional\n2 = Disabled\n3 = RequiredMasked\n4 = OptionalMasked" x-enumNames: - Required - Optional - Disabled - RequiredMasked - OptionalMasked enum: - 0 - 1 - 2 - 3 - 4 IJsonResponseOfCustomerAccountSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CustomerAccountSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CustomerAccountSettings: type: object description: "The booking customer account settings.\n " additionalProperties: false properties: allowCustomerMerge: type: boolean description: "The flag allowing two different customer accounts to be combined\ \ into a single account.\n " allowCustomerProgram: type: boolean description: "The flag allowing the current role to manage user customer\ \ programs.\n " allowSeatLocationOption: type: boolean description: "The flag allowing the current role to manage user seat preferences.\n\ \ " customerAccessControl: description: "The restriction/permissions allowed by the current role.\n\ \ " $ref: '#/components/schemas/CustomerAccessControl' defaultCustomerNotificationPreference: description: "The default notification preferences of the customer.\n \ \ " $ref: '#/components/schemas/NotificationPreference' defaultSeatPreference: description: "The default seat preferences of the customer.\n \ \ " $ref: '#/components/schemas/CustomerSeatPreference' disableCustomerAddress: description: "The restrictions on the customer address fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerCurrency: description: "The restrictions on the customer currency fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerDateOfBirth: description: "The restrictions on the customer date of birth fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerEmail: description: "The restrictions on the customer email fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerFax: description: "The restrictions on the customer fax fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerLanguage: description: "The restrictions on the customer language fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerNationality: description: "The restrictions on the customer nationality fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerNotificationPreference: description: "The restrictions on the customer notification preferences\ \ fields.\n " $ref: '#/components/schemas/FieldControlType' disableCustomerPayment: description: "The restrictions on the customer payment fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerPhone: description: "The restrictions on the customer phone number fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerResidentCountry: description: "The restrictions on the customer resident country fields.\n\ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerTitle: description: "The restrictions on the customer title fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' disableCustomerType: description: "The restrictions on the customer type fields.\n \ \ " $ref: '#/components/schemas/FieldControlType' allowAgentToModifyProgramLevel: type: boolean description: "The flag allowing the agent to modify program level for default\ \ loyalty customer program.\n " maskCustomerName: type: boolean description: "Indicates if the customer name is masked.\n " maskCustomerSuffix: type: boolean description: "Indicates if the customer suffix is masked.\n " maskTravelDocumentDetails: type: boolean description: "Indicates if the travel document details is masked.\n \ \ " maskCustomerWebUserId: type: boolean description: "Indicates if the customer web user ID is masked.\n \ \ " maskCustomerGender: type: boolean description: "Indicates if the customer gender is masked.\n " maskAffiliation: type: boolean description: "Indicates if the corporate or government affiliation is masked.\n\ \ " CustomerAccessControl: type: integer description: "Enumeration for customer access control.\n \n\n0 =\ \ View\n1 = CreateAndChange" x-enumNames: - View - CreateAndChange enum: - 0 - 1 CustomerSeatPreference: type: integer description: "Enumeration for seat preferences.\n \n\n0 = None\n\ 1 = Window\n2 = Aisle\n3 = NoPreference\n4 = Front\n5 = Rear\n6 = WindowFront\n\ 7 = WindowRear\n8 = AisleFront\n9 = AisleRear" x-enumNames: - None - Window - Aisle - NoPreference - Front - Rear - WindowFront - WindowRear - AisleFront - AisleRear enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 IJsonResponseOfFeeSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FeeSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FeeSettings: type: object description: "The booking fee settings.\n " additionalProperties: false properties: allowNegativeFees: type: boolean description: "Gets or sets the flag allowing negative fees.\n \ \ " allowOtherCurrencies: type: boolean description: "Gets or sets the flag allowing other currency fees.\n \ \ " cancelGracePeriod: type: string description: "Gets or sets the timeframe for the cancel grace period.\n\ \ " format: duration nullable: true displayTaxesForFeesOnBreakdown: type: boolean description: "Gets or sets the flag that allows displaying taxes for fees\ \ on the breakdown.\n " feeDescription: description: "Gets or sets the restriction for fee description fields.\n\ \ " $ref: '#/components/schemas/FieldControlType' allowFeesWithPoints: type: boolean description: "Gets or sets the flag that allows selling of fees with points.\n\ \ " doNotAllowFeesToBeDeleted: type: boolean description: "Gets or sets the flag that restricts the deletion of fees.\n\ \ " IJsonResponseOfFlightSearchSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/FlightSearchSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' FlightSearchSettings: type: object description: "The Booking flight search settings.\n " additionalProperties: false properties: bookingMaxPassengers: type: integer description: "The maximum number of passengers allowed on a single booking.\n\ \ " format: int32 allowOpenJaw: type: boolean description: "Flag that indicates if open jaw journeys are allowed.\n \ \ " allowPrivateFares: type: boolean description: "Flag that indicates whether private fares are allowed.\n \ \ " showExpiredFareDateRange: type: integer description: "The number of days after the fare discontinue date that the\ \ agent will be allowed to view the fare.\n " format: int32 maxNumberConnectingFlights: type: integer description: "The maximum number of connections on a journey that will be\ \ returned from availability.\n " primarySortKey: description: "The primary sort to be used on availability response.\n \ \ " $ref: '#/components/schemas/JourneySortKey' secondarySortKey: description: "The secondary sort to be used on the availability response.\n\ \ " $ref: '#/components/schemas/JourneySortKey' maxAvailabilityDateRange: type: integer description: "The maximum number of days between the begin and end date\ \ for regular availability.\n " format: int32 maxLowFareDateRange: type: integer description: "The maximum number of days between the begin and end date\ \ for low fare availability.\n " format: int32 displayLowerFares: description: "Display setting for low fares (used in change flow).\n \ \ " $ref: '#/components/schemas/FareDisplayType' fareClassControl: description: "The fare class filtering when returning journeys during availability.\n\ \ " $ref: '#/components/schemas/FareClassControl' allUpPricing: type: boolean description: "The flag indicating whether to allow anticipated sales taxes\ \ and travel fees when processing the availability\nrequest.\n \ \ " fareSorting: description: "Fare filtering options.\n " $ref: '#/components/schemas/FareSelection' lowFareCacheStatus: description: "The status of the low fare cache.\n " $ref: '#/components/schemas/LowFareCacheOption' sortByInterlineConnections: type: boolean description: "This maps to New Skies' Bias Online Commercial Duplicates.\n\ If set to true the flight availability results are sorted by online connections\ \ (the same carrier for all legs)\nfollowed by the interline connections\ \ (between hosted carriers).\n " FareDisplayType: type: integer description: "Filter used to determine the display status of fares (used during\ \ rebook).\n \n\n0 = HideLowerFares\n1 = ShowAndAllowLowerFares\n\ 2 = ShowButDisableLowerFares" x-enumNames: - HideLowerFares - ShowAndAllowLowerFares - ShowButDisableLowerFares enum: - 0 - 1 - 2 FareSelection: type: integer description: "Identifies which fare to return from availability.\n \ \ \n\n0 = BySortPrice\n1 = ByCalculatedFarePrice" x-enumNames: - BySortPrice - ByCalculatedFarePrice enum: - 0 - 1 LowFareCacheOption: type: integer description: "Determines the low fare caching options.\n \n\n0 =\ \ AlwaysUseCache\n1 = BypassCacheOnRequest\n2 = NeverUseCache" x-enumNames: - AlwaysUseCache - BypassCacheOnRequest - NeverUseCache enum: - 0 - 1 - 2 RoleCodeQuery: type: object description: "Model for a role code query.\n " additionalProperties: false required: - roleCode properties: roleCode: type: string description: "Gets or sets the role code for this request.\n " maxLength: 4 minLength: 1 DeltaMapperOfFlightSearchSettings: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: bookingMaxPassengers: type: integer description: "The maximum number of passengers allowed on a single booking.\n\ \ " format: int32 allowOpenJaw: type: boolean description: "Flag that indicates if open jaw journeys are allowed.\n \ \ " allowPrivateFares: type: boolean description: "Flag that indicates whether private fares are allowed.\n \ \ " showExpiredFareDateRange: type: integer description: "The number of days after the fare discontinue date that the\ \ agent will be allowed to view the fare.\n " format: int32 maxNumberConnectingFlights: type: integer description: "The maximum number of connections on a journey that will be\ \ returned from availability.\n " primarySortKey: description: "The primary sort to be used on availability response.\n \ \ " $ref: '#/components/schemas/JourneySortKey' secondarySortKey: description: "The secondary sort to be used on the availability response.\n\ \ " $ref: '#/components/schemas/JourneySortKey' maxAvailabilityDateRange: type: integer description: "The maximum number of days between the begin and end date\ \ for regular availability.\n " format: int32 maxLowFareDateRange: type: integer description: "The maximum number of days between the begin and end date\ \ for low fare availability.\n " format: int32 displayLowerFares: description: "Display setting for low fares (used in change flow).\n \ \ " $ref: '#/components/schemas/FareDisplayType' fareClassControl: description: "The fare class filtering when returning journeys during availability.\n\ \ " $ref: '#/components/schemas/FareClassControl' allUpPricing: type: boolean description: "The flag indicating whether to allow anticipated sales taxes\ \ and travel fees when processing the availability\nrequest.\n \ \ " fareSorting: description: "Fare filtering options.\n " $ref: '#/components/schemas/FareSelection' lowFareCacheStatus: description: "The status of the low fare cache.\n " $ref: '#/components/schemas/LowFareCacheOption' sortByInterlineConnections: type: boolean description: "This maps to New Skies' Bias Online Commercial Duplicates.\n\ If set to true the flight availability results are sorted by online connections\ \ (the same carrier for all legs)\nfollowed by the interline connections\ \ (between hosted carriers).\n " IJsonResponseOfGeneralSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/GeneralSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' GeneralSettings: type: object description: "The booking general settings.\n " additionalProperties: false properties: allowChangeSsrOnCheckedInPassenger: type: boolean description: "The flag allowing adding and removing SSRs on a checked-in\ \ passenger.\n " allowBlockedSeatAssignment: type: boolean description: "The flag allowing blocked seat assignment.\n " allowChangeOnRestrictedFlight: type: boolean description: "The flag allowing changing the booking on a restricted flight.\n\ \ " allowPromoCodes: type: boolean description: "The flag allowing promo codes.\n " allowEditableApiChannel: type: boolean description: "The flag allowing changes on a booking made through the API\ \ channel.\n " allowEditableDirectChannel: type: boolean description: "The flag allowing changes on a booking made through the direct\ \ channel.\n " allowEditableGdsBookingWithTaPayment: type: boolean description: "The flag allowing the current role to edit GDS bookings with\ \ TA payments.\n " allowEditableGdsChannel: type: boolean description: "The flag allowing the current role to edit bookings created\ \ through GDS.\n " allowEditableWebChannel: type: boolean description: "The flag allowing the current role to edit bookings created\ \ through the web channel.\n " allowGroupNameUpdates: type: boolean description: "The flag allowing group names to be updated on non-GDS flights.\n\ \ " allowManifestRetrievalOnUnblockedFlightLines: type: boolean description: "The flag allowing manifest retrieval on Unblocked flight lines\n\ \ " allowOverbookingSsrOnMove: type: boolean description: "The flag allowing overbooking SSRs on Move.\n " allowQueueingGdsBookingWithTaFopForETicketReissue: type: boolean description: "The flag allowing queuing GDS booking with TA FOP for ETicket\ \ Reissues.\n " allowRestrictedSeatAssignment: type: boolean description: "The flag allowing restricted seat assignments.\n \ \ " allowSeatAssignment: description: "The seat assignment rules for this role.\n " $ref: '#/components/schemas/SeatAssignmentRole' bookingAccessControl: description: "The booking access allowed on this role.\n " $ref: '#/components/schemas/BookingAccessControl' viewBookingsByControl: description: "The highest organization that the role can view bookings for.\n\ \ " $ref: '#/components/schemas/GroupAccessControl' editBookingsByControl: description: "The highest organization that the role can edit bookings for.\n\ \ " $ref: '#/components/schemas/GroupAccessControl' defaultBookingComment: type: string description: "The mandatory booking comment.\n " nullable: true doNotIncludeUnitProperties: type: boolean description: "The flag to not include unit properties in notification itinerary.\n\ \ " duplicateBookingDetectionTimeSpan: type: string description: "The timespan where duplicate bookings are watched for on this\ \ role.\n " format: duration nullable: true enableAutomaticSeatAssignment: type: boolean description: "The flag allowing automatic seat assignment on this role.\n\ \ " highlightFareOverride: description: "The option to highlight the fare override on this role.\n\ \ " $ref: '#/components/schemas/HighlightOption' highlightIrop: description: "The option to highlight IROP information on this role.\n \ \ " $ref: '#/components/schemas/HighlightOption' highlightScheduleChange: description: "The option to highlight schedule changes on this role.\n \ \ " $ref: '#/components/schemas/HighlightOption' highlightStandby: description: "The option to highlight standbys on this role.\n \ \ " $ref: '#/components/schemas/HighlightOption' highlightUpgrade: description: "The option to highlight upgrades on this role.\n \ \ " $ref: '#/components/schemas/HighlightOption' managePassiveSegments: type: boolean description: "The flag to allow managing passive segments on this role.\n\ \ " maskHistory: type: boolean description: "Determines if Booking, Queue and Notification History in a\ \ PNR is masked.\n " reassignSeatingBehavior: description: "The reassign seat behavior for this role.\n " $ref: '#/components/schemas/ReassignSeatingBehavior' restrictedExternalSystemCodes: type: array description: "Gets or sets a list of restricted external system codes for\ \ this role.\n " nullable: true items: type: string timeDisplay: description: "The time display style for this role.\n " $ref: '#/components/schemas/TimeDisplay' allowSeatGroupRestrictionOverride: type: boolean description: "The allow seat group restriction override flag.\n \ \ " allowAccessToComments: type: boolean description: "The allow access to comments flag.\n " sharedCommentTypes: description: "The comment types that can be shared with the booking source.\n\ \ " nullable: true $ref: '#/components/schemas/SharedCommentType' allowOverrideOfSalesChannel: type: boolean description: "The flag for allowing overriding of sales channel.\n \ \ " autoFillContactInformationByPhoneNumber: type: boolean description: "The flag that configures auto-filling and auto-saving of contact\ \ information\nwhen a phone number is provided on creating a booking for\ \ various user interfaces.\n " allowAccessToArchivedBooking: type: boolean description: "Allows a role to access archived bookings\n " allowQueueBookingsOnSpecifiedLeg: type: boolean description: "Allows a role to queue bookings on a specified leg.\n \ \ " queueFlightOpenTimeSpan: type: string description: "Indicates the time span before departure when flight can no\ \ longer be processed.\n " format: duration nullable: true queueFlightCloseTimeSpan: type: string description: "Indicates the time span after departure when flight can no\ \ longer be processed.\n " format: duration nullable: true allowReleaseHeldSessionSeat: type: boolean description: "The flag allowing agents to release seats held in a session.\n\ \ " SeatAssignmentRole: type: integer description: "The Enumeration indicates the seat assignment permissions for\ \ selling.\n \n\n0 = Never\n1 = OnlyOnUnheldBookings\n2 = Always" x-enumNames: - Never - OnlyOnUnheldBookings - Always enum: - 0 - 1 - 2 BookingAccessControl: type: integer description: "Enumeration representing access rights to booking operations.\ \ Each value has access to all the values below it.\n \n\n0 = None\n\ 1 = ScheduleOnly\n2 = Availability\n3 = View\n4 = ModifyNoCommit\n5 = Create\n\ 6 = Change\n7 = CreateAndChange" x-enumNames: - None - ScheduleOnly - Availability - View - ModifyNoCommit - Create - Change - CreateAndChange enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 GroupAccessControl: type: integer description: "Enumeration that represents the access rights to groups.\n \ \ \n\n0 = Agent\n1 = Organization\n2 = OrganizationGroup\n3 = All" x-enumNames: - Agent - Organization - OrganizationGroup - All enum: - 0 - 1 - 2 - 3 HighlightOption: type: integer description: "Enumeration representing highlight options\n \n\n0\ \ = None\n1 = Highlight" x-enumNames: - None - Highlight enum: - 0 - 1 ReassignSeatingBehavior: type: integer description: "Enumeration with possible seat reassignment behaviors during any\ \ type of flight move.\n \n\n0 = DropSeats\n1 = LikeForLike\n2\ \ = Algorithm\n3 = SameSeatGroup" x-enumNames: - DropSeats - LikeForLike - Algorithm - SameSeatGroup enum: - 0 - 1 - 2 - 3 TimeDisplay: type: integer description: "Enumeration for the different time display options.\n \ \ \n\n0 = Default\n1 = AmPm\n2 = TwentyFourHour" x-enumNames: - Default - AmPm - TwentyFourHour enum: - 0 - 1 - 2 SharedCommentType: type: object description: "The shared comment types for the booking source.\n " additionalProperties: false properties: reservation: type: boolean description: "Indicates if the role is allowed to share the reservation\ \ comment type with the booking source.\n " itinerary: type: boolean description: "Indicates if the role is allowed to share the itinerary comment\ \ type with the booking source.\n " manifest: type: boolean description: "Indicates if the role is allowed to share the manifest comment\ \ type with the booking source.\n " alert: type: boolean description: "Indicates if the role is allowed to share the alert comment\ \ type with the booking source.\n " IJsonResponseOfReserveFlightsSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ReserveFlightsSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ReserveFlightsSettings: type: object description: "The booking reserve flight settings.\n " additionalProperties: false properties: availabilityDepartureTimeLimit: type: string description: "Time limit for availability departure from current date and\ \ time.\n " format: duration availabilityMaxDaysOut: type: string description: "Time indicating when flights cannot depart or return from\ \ current date and time.\n " format: duration sellDepartureTimeLimit: type: string description: "Time indicating when flights cannot be booked/sold from current\ \ date and time.\n " format: duration availableSpaceDisplayMax: type: integer description: "The maximum available seats displayed.\n " format: int32 flightTimeChangeToleranceMinutes: type: integer description: "Number of flight time change tolerance minutes.\n \ \ " format: int32 viewCapacity: type: boolean description: "Flag indicating if whether the agent is allowed to view aircraft\ \ capacity.\n " viewLidSold: type: boolean description: "Flag indicating whether the agent is allowed to view aircraft\ \ lid and seats sold counts.\n " viewSsrAvailability: type: boolean description: "Flag indicating whether the agent is allowed to view ssr availability.\n\ \ " viewManifestControl: description: "Indicator whether the agent is allowed to view manifest.\n\ \ " $ref: '#/components/schemas/ViewManifestControl' adHocFlightControl: description: "Indicator on permissions for AdHoc flight operations.\n \ \ " $ref: '#/components/schemas/AdHocFlightControl' allowSellOverbook: description: "Indicator whether the agent is allowed to overbook except\ \ on moves.\n " $ref: '#/components/schemas/OverbookControl' allowMoveOverbook: description: "Indicator whether the agent is allowed to overbook on move\ \ only.\n " $ref: '#/components/schemas/OverbookControl' allowUpgradeOverbook: description: "Indicator whether the agent is allowed to overbook on upgrade\ \ only.\n " $ref: '#/components/schemas/OverbookControl' allowSplitJourneyMoves: type: boolean description: "Flag indicating whether the agent allows split-journey moves.\n\ \ " allowMove: description: "Indicator whether the agent is allowed to move a passenger\ \ from a flight to another without repricing.\n " $ref: '#/components/schemas/MoveFlightCode' moveByMaximumClassAvailability: type: boolean description: "Flag indicating if move by maximum class availability.\n \ \ " requireSameCityPairOnMoves: type: boolean description: "Flag indicating if same city pairs are required on move.\n\ \ " maxMoveDaysForward: type: string description: "They number of days that are allowed to move forward.\n \ \ " format: duration maxMoveDaysBack: type: string description: "The number of days that are allowed to move backwards.\n \ \ " format: duration daysBeforeIrop: type: string description: "The number of days before IROP.\n " format: duration allowFareOverride: type: boolean description: "Flag indicating whether the agent is allowed to override the\ \ fare.\n " allowClosedFlightFareOverride: type: boolean description: "Flag indicating whether the agent is allowed to override the\ \ fare of a closed or flown flight.\n " allowFareOverrideDuringDivide: type: boolean description: "Flag indicating whether the agent is allowed to override the\ \ fare of a closed or flown flight.\n " allowIgnoreRestrictions: type: boolean description: "Flag indicating whether the agent is allowed to ignore fare\ \ restrictions on end record.\n " allowInvalidPriceStatus: type: boolean description: "Flag indicating whether the agent is allowed to End record\ \ with an invalid price.\n " cancelDepartureTimeLimit: type: string description: "Denotes the time before departure when an agent can no longer\ \ change/cancel a flight.\n " format: duration seatAssignmentTimeLimit: type: string description: "Denotes the time before departure when an agent can no longer\ \ change/cancel a flight.\n " format: duration allowUpgrade: type: boolean description: "Flag indicating if upgrades are allowed.\n " allowCreateAdhocConnect: type: boolean description: "Flag indicating if AdHoc is allowed.\n " minimumTimeBetweenFlightsEnforcement: type: boolean description: "Flag indicating whether the minimum time between flights setting\ \ timespan is to be enforced.\n " upgradeDepartureTimeLimit: type: string description: "Denotes the time before departure when an agent can no longer\ \ change/cancel a flight.\n " format: duration upgradeCabinStartOffset: type: string description: "Denotes the time before departure the agent can start offering\ \ cabin upgrades.\n " format: duration minimumTimeBetweenFlights: type: string description: "Denotes the minimum time between flights allowed.\n \ \ " format: duration modifyPassiveSegmentTimes: type: boolean description: "Flag indicating whether or not flight times on unmanaged records\ \ are overwritten.\n " allowSellOfFlightOverlap: type: boolean description: "Flag indicating whether or not to support selling of overlapping\ \ flights across all booking channels.\n " availabilityMaxDate: type: string description: "Cannot book flights whose departure or return date exceeds\ \ date.\n " format: date-time allowedFareOverrideType: description: "Controls which type of fare overrides are allowed by a role.\n\ \ " $ref: '#/components/schemas/AllowedFareOverrideType' allowMoveOnInitialBooking: type: boolean description: "Flag indicating whether or not to allow a trip move for the\ \ initial (non-committed) booking.\n " allowDowngrade: type: boolean description: "Flag indicating if downgrades are allowed.\n " allowDowngradeOverbook: description: "Indicates if the agent is allowed to overbook when downgrading\ \ a class of service.\n " $ref: '#/components/schemas/OverbookControl' allowRestoreOverbook: description: "Indicates if the agent is allowed to overbook when restoring\ \ a class of service.\n " $ref: '#/components/schemas/OverbookControl' enableCheckValidPrice: type: boolean description: "Indicates if the agent is allowed to validate fare restrictions\ \ of the booking in state.\n " enableTroubleshootingButton: type: boolean description: "Indicates if the agent is allowed to troubleshoot on the flight\ \ results screen.\n " ViewManifestControl: type: integer description: "Desfines the view manifest control options.\n \n\n\ 0 = None\n1 = StandbyOnly\n2 = Full" x-enumNames: - None - StandbyOnly - Full enum: - 0 - 1 - 2 AdHocFlightControl: type: integer description: "Defines the permissions for AdHoc flight operations.\n \ \ \n\n0 = None\n1 = View\n2 = Sell" x-enumNames: - None - View - Sell enum: - 0 - 1 - 2 OverbookControl: type: integer description: "Defines the access rights to overbook.\n \n\n0 = CannotOverbook\n\ 1 = CanOverbookClass\n2 = CanOverbookNest\n3 = CanOverbookLeg" x-enumNames: - CannotOverbook - CanOverbookClass - CanOverbookNest - CanOverbookLeg enum: - 0 - 1 - 2 - 3 MoveFlightCode: type: integer description: "Defines the move flight\n \n\n0 = NotAllowed\n1 = AllowedOnInventory\n\ 2 = Allowed" x-enumNames: - NotAllowed - AllowedOnInventory - Allowed enum: - 0 - 1 - 2 AllowedFareOverrideType: type: integer description: "Enumeration representing which type of fare overrides are allowed\ \ by a role.\n \n\n0 = DiscountedPrice\n1 = PublishedPrice\n2 =\ \ All" x-enumNames: - DiscountedPrice - PublishedPrice - All enum: - 0 - 1 - 2 IJsonResponseOfPassengerSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerSettings: type: object description: "The booking passenger settings.\n " additionalProperties: false properties: passengerTitle: description: "Passenger title field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerFirstName: description: "Passenger first name field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerMiddleName: description: "Passenger middle name field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerLastName: description: "Passenger last name field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerSuffix: description: "Passenger suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerCustomerNumber: description: "Passenger customer number field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerGender: description: "Passenger gender field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerDateOfBirth: description: "Passenger date of birth field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerNationality: description: "Passenger nationality field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerResidentCountry: description: "Passenger resident country field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' infantTitle: description: "Infant title field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantFirstName: description: "Infant first name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantMiddleName: description: "Infant middle name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantLastName: description: "Infant last name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantSuffix: description: "Infant suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantGender: description: "Infant gender field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantDateOfBirth: description: "Infant date of birth field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' infantNationality: description: "Infant nationality field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantResidentCountry: description: "Infant resident country field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' tbaPassengersAllowed: description: "TBA passenger will allow users to enter passengers with information\ \ \"To Be Determined\".\n " $ref: '#/components/schemas/TbaPassengersAllowed' allowCustomerProgram: type: boolean description: "Flag to indicate if passenger customer programs are allowed.\n\ \ " allowNameChange: type: boolean description: "Flag to indicate if passenger name changes are allowed.\n\ \ " maskedGdprSettings: description: "GDPR related settings that are masked.\n " nullable: true $ref: '#/components/schemas/PassengerGdprSettings' TbaPassengersAllowed: type: integer description: "Defines the TBA passengers allowed enumeration.\n \n\ \n0 = Never\n1 = IfFirstPassengerIsKnown\n2 = Always" x-enumNames: - Never - IfFirstPassengerIsKnown - Always enum: - 0 - 1 - 2 PassengerGdprSettings: type: object description: "The GDPR related settings for the passenger role settings.\n \ \ " additionalProperties: false properties: travelDocumentInformation: type: boolean description: "Flag to indicate if the passenger travel document information\ \ is masked.\n " travelDocumentDetails: type: boolean description: "Flag to indicate if the passenger travel document details\ \ is masked.\n " otherAirlineFrequentFlyer: type: boolean description: "Flag to indicate if the passenger OA frequent flyer is masked.\n\ \ " ssrNotes: type: boolean description: "Flag to indicate if the passenger SSR notes are masked.\n\ \ " addressTypes: type: array description: "The list of address types that are masked.\n " nullable: true items: $ref: '#/components/schemas/ApisAddressStatus' travelNotificationDeliveryAddress: type: boolean description: "Flag to indicate if the passenger travel notification delivery\ \ address is masked.\n " DeltaMapperOfPassengerSettings: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: passengerTitle: description: "Passenger title field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerFirstName: description: "Passenger first name field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerMiddleName: description: "Passenger middle name field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerLastName: description: "Passenger last name field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerSuffix: description: "Passenger suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerCustomerNumber: description: "Passenger customer number field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerGender: description: "Passenger gender field validation control.\n " $ref: '#/components/schemas/FieldControlType' passengerDateOfBirth: description: "Passenger date of birth field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerNationality: description: "Passenger nationality field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' passengerResidentCountry: description: "Passenger resident country field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' infantTitle: description: "Infant title field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantFirstName: description: "Infant first name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantMiddleName: description: "Infant middle name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantLastName: description: "Infant last name field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantSuffix: description: "Infant suffix field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantGender: description: "Infant gender field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantDateOfBirth: description: "Infant date of birth field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' infantNationality: description: "Infant nationality field validation control.\n " $ref: '#/components/schemas/FieldControlType' infantResidentCountry: description: "Infant resident country field validation control.\n \ \ " $ref: '#/components/schemas/FieldControlType' tbaPassengersAllowed: description: "TBA passenger will allow users to enter passengers with information\ \ \"To Be Determined\".\n " $ref: '#/components/schemas/TbaPassengersAllowed' allowCustomerProgram: type: boolean description: "Flag to indicate if passenger customer programs are allowed.\n\ \ " allowNameChange: type: boolean description: "Flag to indicate if passenger name changes are allowed.\n\ \ " maskedGdprSettings: description: "GDPR related settings that are masked.\n " nullable: true properties: travelDocumentInformation: type: boolean description: "Flag to indicate if the passenger travel document information\ \ is masked.\n " travelDocumentDetails: type: boolean description: "Flag to indicate if the passenger travel document details\ \ is masked.\n " otherAirlineFrequentFlyer: type: boolean description: "Flag to indicate if the passenger OA frequent flyer is\ \ masked.\n " ssrNotes: type: boolean description: "Flag to indicate if the passenger SSR notes are masked.\n\ \ " addressTypes: type: array description: "The list of address types that are masked.\n \ \ " nullable: true items: $ref: '#/components/schemas/ApisAddressStatus' travelNotificationDeliveryAddress: type: boolean description: "Flag to indicate if the passenger travel notification\ \ delivery address is masked.\n " IJsonResponseOfBookingPaymentCodesSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BookingPaymentCodesSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingPaymentCodesSettings: type: object description: "The booking payments codes settings.\n " additionalProperties: false properties: voucherConfigurationCodes: type: array description: "The collection of allowed voucher configuration codes.\n \ \ " nullable: true items: type: string IJsonResponseOfPaymentSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PaymentSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PaymentSettings: type: object description: "The payment settings.\n " additionalProperties: false properties: defaultCommentForCreditShell: type: string description: "Hold the default comment that will be applied for a credit\ \ shell payment.\n " nullable: true webDeclinedPaymentHoldPeriod: type: integer description: "Web declined payment hold period.\n " format: int32 directDeclinedPaymentHoldPeriod: type: integer description: "Direct declined payment hold period.\n " format: int32 gdsDeclinedPaymentHoldPeriod: type: integer description: "GDS declined payment hold period.\n " format: int32 apiDeclinedPaymentHoldPeriod: type: integer description: "API declined payment hold period.\n " format: int32 autoCancelChargeBackPaymentHolds: type: boolean description: "Auto cancel charge back payment holds.\n " allowZeroAmountFormOfPayment: type: boolean description: "Allow zero amount form of payment.\n " includeInFirstInstallmentFeeCodes: type: array description: "Include in first installment fee codes.\n " nullable: true items: type: string retainHoldStatusUntilPaymentAuthorization: type: boolean description: "Retain hold status until payment authorization.\n \ \ " validateCurrencyEnforcedAgainstPaymentType: description: "The currency to use when validating a payment.\n \ \ " $ref: '#/components/schemas/ValidatePaymentCurrencyType' numberOfDeclinedRefundAndReverseAttempts: type: integer description: "The number of declined refund and reverse attempts allowed.\n\ \ " format: int32 ValidatePaymentCurrencyType: type: integer description: "Enumeration with the options for which currency to use when validating\ \ a payment type\n \n\n0 = BookingCurrency\n1 = PaymentCurrency" x-enumNames: - BookingCurrency - PaymentCurrency enum: - 0 - 1 IJsonResponseOfGeneralBookingSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/GeneralBookingSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' GeneralBookingSettings: type: object description: "Settings for the general booking settings that are not role specific.\n\ \ " additionalProperties: false properties: maximumAgeForInfantInLap: type: integer description: "The maximum age (in months) for the infant-in-lap.\n \ \ " format: int32 useDirectCurrencyConversion: type: boolean description: "If true, the direct currency conversion is being used instead\ \ to the default inverse calculation.\n " clearInfantDetailsWhenInfantInLapIsDeleted: type: boolean description: "If true, the infant details are cleared when an infant in\ \ lap is deleted from a passenger.\n " mixedClassRouteFaresEnabled: type: boolean description: "If true, the RBD functionality is enabled in the booking flow.\n\ \ " sumOfSectorFaresEnabled: type: boolean description: "If true, the the sum-of-sectors fares are enabled for the\ \ current environment.\n " sumOfSectorProductClassPreCompression: type: boolean description: "If true, the the sum-of-sectors faring logic will pre-compress\ \ the set of available fares for\neach segment by product class prior\ \ to considering all possible combinations of those fares\nagainst the\ \ journey.\n " sellSeatSsrBeforeAssignment: type: boolean description: "If true, a seat dependent ssr can be sold before a seat assignment\ \ is made.\n " applyAllUpPricingGlobally: type: boolean description: "If true, this is equivalent to setting the 'Include sales\ \ tax and travel fees to the\nfare price at availability' setting on all\ \ markets. The user's role setting may still\noverride this. This may\ \ also be overridden on a per-request basis in the availability\nrequest.\n\ \ " repriceWhenCustomerProgramIsChanged: type: boolean description: "If true, changing a passenger's customer program will trigger\ \ an immediate re-price step\neven if no other passenger details were\ \ changed. Changing other pricing-sensitive passenger\ncriteria such\ \ as the passenger's type code or discount code will always trigger an\ \ immediate\nre-price step regardless of this setting.\n " recalculateHoldWithBookingChanges: type: boolean description: "If true, the hold time will be restarted (i.e. reset) when\ \ the first un-flown host segment/journey\nis modified in the booking.\n\ \ " preventCommitBookingWithCancelledInventory: type: boolean description: "If true, a booking commit will not be allowed for a booking\ \ with cancelled inventory.\n " defaultCarrierCode: type: string description: "The default carrier code for the current environment.\n \ \ " nullable: true defaultBookingSubQueueCode: type: string description: "The default booking sub-queue code for the current environment.\n\ \ " nullable: true maximumNumberOfMarkets: type: integer description: "The maximum number of city pairs or journeys that will be\ \ supported during a search\n(multi-city shopping mode).\n " format: int32 interlineHoldBeforeDeparture: type: integer description: "The hold time in minutes when host flights are booked by external\ \ source in conjunction with\nother airline (OA) flights.\n \ \ " format: int32 warningTimeBeforeHoldCancel: type: integer description: "Indicates how long in hours before a hold expires that a notification\ \ will be sent.\n " format: int32 interlineConnectionPartners: type: string description: "Indicates the carrier codes of interline partners that can\ \ form an interline connection\nin a booking.\n " nullable: true applyFareForInLapInfantWithPassengerType: type: string description: "If this value is empty, an ssr fee will be added for an infant\ \ in lap. If this has a valid\npassenger type code, a fare for the in-lap\ \ infant will be added using the specified passenger\ntype code. Note\ \ that when this is set, the value of TaxInfantSSRAsFareWithPassengerType\ \ is\nno longer used.\n " nullable: true validateMaximumAgeBy: type: string description: "Indicates whether to validate the maximum age by booking date\ \ or on the first non-passive segment on the booking\n " nullable: true validateMinimumAgeBy: type: string description: "Indicates whether to validate the minimum age by the first\ \ or last non-passive segment on the booking.\n " nullable: true indiaGstRegistrationContactType: type: string description: "The contact type to use for India GST registration details.\n\ \ " nullable: true enforceStandardGroupBooking: type: boolean description: "Indicates if standard group bookings are enforced.\n \ \ " storeConfirmingWaivedFees: type: boolean description: "Indicates if waived fees in the confirming state are kept\ \ as part of the booking data when being overridden.\n " personallyIdentifiableInformationMasking: type: boolean description: "Indicates if personally identifiable information masking is\ \ enabled.\n " lowFareCacheMode: type: string description: "The low fare cache mode settings.\n " nullable: true retrieveFareInformationFromGeneralReferenceManagement: type: boolean description: "Indicates if fare rule information should be retrieved from\ \ the general reference management or from the category\n50 rule information\ \ supplied to the fare.\n " enableGenderNeutral: type: boolean description: "Indicates if the support for non-binary genders is enabled.\n\ \ " storeDeletedManuallyAddedFees: type: boolean description: "If enabled, manually-added fees that have been deleted by\ \ agents will be overridden to zero with an\nindicator/ChargeDetail of\ \ \"Fee DL\" instead of being deleted.\nThe setting StoreConfirmingWaivedFees\ \ must be set to true in order for this setting to take effect.\n \ \ " invalidNameCharacters: type: string description: "The characters that are considered invalid for passenger and\ \ contact name fields.\n " nullable: true IJsonResponseOfLoyaltySettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/LoyaltySettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' LoyaltySettings: type: object description: "Loyalty settings\n " additionalProperties: false properties: defaultLoyaltyCustomerProgramCode: type: string description: "The default loyalty customer program code.\n " nullable: true useCustomerNumberForLoyaltyPayments: type: boolean description: "The flag whether to use customer number for loyalty payments.\n\ \ " autoEnrollment: description: "The loyalty auto enrollment, if it is enabled and if so which\ \ method is in use.\n " $ref: '#/components/schemas/LoyaltyAutoEnrollment' LoyaltyAutoEnrollment: type: integer description: "Defines the loyalty auto enrollment setting.\n \n\n\ 0 = None\n1 = Always\n2 = Auto\n3 = AutoCreate" x-enumNames: - None - Always - Auto - AutoCreate enum: - 0 - 1 - 2 - 3 IJsonResponseOfPhoneNumberValidationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PhoneNumberValidationSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PhoneNumberValidationSettings: type: object description: "Represents the settings for phone number validation.\n \ \ " additionalProperties: false properties: displayText: type: string description: "The display text that describes the required format.\nExample:\ \ (###) ###-####\n " nullable: true validationType: description: "The validation method used.\n " $ref: '#/components/schemas/PhoneNumberValidationType' validationRequirements: type: array description: "The list of values that determines if a phone number is a\ \ valid.\n " nullable: true items: type: string PhoneNumberValidationType: type: integer description: "Phone number validation mode enumeration.\n \n\n0 =\ \ None\n1 = FixedDigits\n2 = StringPattern" x-enumNames: - None - FixedDigits - StringPattern enum: - 0 - 1 - 2 IJsonResponseOfETicketConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ETicketConfiguration' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ETicketConfiguration: type: object description: "The e-ticket-related configuration data.\n " additionalProperties: false properties: active: type: boolean description: "Indicates if the configuration is active or inactive.\n \ \ " code: type: string description: "The configuration code.\n " nullable: true description: type: string description: "The configuration description.\n " nullable: true messageContent: description: "The message content configuration data.\n " nullable: true $ref: '#/components/schemas/MessageContent' messageDelivery: description: "The message delivery configuration data.\n " nullable: true $ref: '#/components/schemas/MessageDelivery' issuingCarrier: type: string description: "The issuing carrier of the e-ticket.\n " nullable: true eTicketPointOfSale: description: "The point of sale configuration data.\n " nullable: true $ref: '#/components/schemas/ETicketPointOfSale' MessageContent: type: object description: "The configuration data for e-ticketing message content.\n \ \ " additionalProperties: false properties: ticketSettings: description: "The ticket settings.\n " nullable: true $ref: '#/components/schemas/TicketSettings' couponSettings: description: "The coupon settings.\n " nullable: true $ref: '#/components/schemas/CouponSettings' applyDualTvlForCodeShareFlights: type: boolean description: "Controls the format of code share flights in e-ticket issue\ \ and reissue messages.\n " TicketSettings: type: object description: "The ticket level settings for the e-ticket message content.\n\ \ " additionalProperties: false properties: applyInvoluntaryIndicatorForETicketFareCalculation: type: boolean description: "Indicates if an involuntary indicator will be included in\ \ the fare calculation as part of the ticketing message for\ninvoluntary\ \ reissue requests.\n " includeOriginalIssueDataOnETicketIssue: type: boolean description: "Indicates if the original issue data will be included in the\ \ e-ticket issue request.\n " reissueAllUnusedCoupons: type: boolean description: "If set to true, all unflown segment ticket coupons are reissued\ \ during involuntary reissue.\nOtherwise, only unflown segment ticket\ \ coupons caused by schedule change or re-accommodations and impacted\ \ coupons\nwill be reissued.\n " useCityCodeForFareCalculationAndOdi: type: boolean description: "If set to true, the fare calculation will be generated using\ \ the configured city code for the station code.\n " endorsementComment: description: "The issue and reissue endorsement comment.\n " nullable: true $ref: '#/components/schemas/EndorsementComment' baseFareRoundingUnits: type: array description: "The collection of base fare currency codes and rounding units.\n\ \ " nullable: true items: $ref: '#/components/schemas/BaseFareRoundingUnit' EndorsementComment: type: object description: "The configuration data for generating endorsement comment.\n \ \ " additionalProperties: false properties: voluntaryReissueComment: type: string description: "The issue (EDIFACT #130) and reissue (EDIFACT #134) ticketing\ \ message in the IFT 4:10 segment when e-tickets\nare issued and/or reissued\ \ for voluntary transactions.\n " nullable: true voluntaryEndorsementRuleSet: type: string description: "The outbound rule set that will be evaluated to generate the\ \ endorsement comment.\n " nullable: true involuntaryReissueComment: type: string description: "The reissue (EDIFACT #134) ticketing message in the IFT 4:10\ \ segment when e-tickets are reissued for involuntary\ntransactions.\n\ \ " nullable: true BaseFareRoundingUnit: type: object description: "The currency code and rounding unit configuration for e-tickets.\n\ \ " additionalProperties: false properties: currencyCode: type: string description: "The currency code.\n " nullable: true roundingUnit: type: string description: "The rounding unit.\n " nullable: true CouponSettings: type: object description: "The coupon level settings for the e-ticket message content.\n\ \ " additionalProperties: false properties: applyFareDiscountToInfant: type: boolean description: "If true, the infant will inherit the fare discount code of\ \ the adult and append the fare discount code with\n'IN'. Otherwise, the\ \ lap infant designator will contain 'IN' plus the percentage of discount\ \ applied from the\npublished fare (ex. IN90).\n " bagQuantity: type: integer description: "The number of bags allowed per passenger.\n " format: int32 MessageDelivery: type: object description: "The configuration data for e-ticketing message delivery.\n \ \ " additionalProperties: false properties: applicationReference: type: string description: "The application reference.\n " nullable: true routeIp: type: string description: "The IP address and port number where the message will be routed.\n\ \ " nullable: true layer5ReferenceCode: type: string description: "The code used to determine the target system where the message\ \ will be sent.\n " nullable: true interchangeHeader: description: "The message header data.\n " nullable: true $ref: '#/components/schemas/InterchangeHeader' InterchangeHeader: type: object description: "The configuration data for the message delivery interchange header.\n\ \ " additionalProperties: false properties: characterSet: description: "The character set used as delimiter for ticketing requests.\n\ \ " $ref: '#/components/schemas/CharacterSet' receiver: description: "The next-hop or receiving system.\n " nullable: true $ref: '#/components/schemas/InterchangeSystem' sender: description: "The sending system.\n " nullable: true $ref: '#/components/schemas/InterchangeSystem' version: description: "The EDIFACT version for ticketing requests.\n " $ref: '#/components/schemas/EdifactVersion' CharacterSet: type: integer description: "Defines the list of supported character set used as delimiter\ \ by e-ticket parsers.\n \n\n0 = Iata\n1 = Iatb" x-enumNames: - Iata - Iatb enum: - 0 - 1 InterchangeSystem: type: object description: "The configuration data for the message delivery interchange system.\n\ \ " additionalProperties: false properties: systemCode: type: string description: "The IATA-assigned system code for the sending or receiving\ \ system.\n " nullable: true systemCodeQualifier: type: string description: "The code qualifier of the sending or receiving system.\n \ \ " nullable: true routingAddress: type: string description: "The routing address.\n " nullable: true EdifactVersion: type: integer description: "Defines the list of supported EDIFACT version for ticketing requests.\n\ \ \n\n0 = Unknown\n1 = Version032\n2 = Version081" x-enumNames: - Unknown - Version032 - Version081 enum: - 0 - 1 - 2 ETicketPointOfSale: type: object description: "The configuration data for e-ticketing point of sale.\n \ \ " additionalProperties: false properties: deliveringSystem: description: "The delivering system.\n " nullable: true $ref: '#/components/schemas/DeliveringSystem' originator: description: "The originator details.\n " nullable: true $ref: '#/components/schemas/OriginatorDetails' system: description: "The system details.\n " nullable: true $ref: '#/components/schemas/SystemDetails' DeliveringSystem: type: object description: "The configuration data for the e-ticket point of sale delivering\ \ system.\n " additionalProperties: false properties: carrierCode: type: string description: "The airline code of the system that delivers the message.\n\ Can also be referred to as Company Identifier.\n " nullable: true companyIdNumber: type: string description: "The company ID number.\n " nullable: true stationCode: type: string description: "The station code of the delivering system's physical location.\n\ Can also be referred to as Place Location Identifier or Location Code.\n\ \ " nullable: true OriginatorDetails: type: object description: "The configuration data for the e-ticket point of sale originator\ \ details.\n " additionalProperties: false properties: authorityRequestCode: type: string description: "The authority request code.\n " nullable: true countryCode: type: string description: "The country code.\n " nullable: true currencyCode: type: string description: "The currency code.\n " nullable: true inHouseAuthorityCode: type: string description: "The authority code or reference number assigned to the requester.\n\ \ " nullable: true travelAgentCode: type: string description: "The booking agent IATA number.\n " nullable: true SystemDetails: type: object description: "The configuration data for the e-ticket point of sale system details.\n\ \ " additionalProperties: false properties: originatorType: type: string description: "The originator type.\n " nullable: true stationCode: type: string description: "The station code of the system that initiates the message.\n\ Can also be referred to as Place Location Identifier or Location Code.\n\ \ " nullable: true IJsonResponseOfCustomerProgramSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CustomerProgramSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CustomerProgramSettings: type: object description: "Customer program settings\n " additionalProperties: false properties: loyaltyMergeEnabled: type: boolean description: "Indicates whether merging loyalty accounts is enabled.\n \ \ " IJsonResponseOfIListOfShoppingAttributeGroup: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ShoppingAttributeGroup' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ShoppingAttributeGroup: type: object description: "Model for a shopping attribute groups.\n " additionalProperties: false required: - shoppingAttributeGroupCode properties: inActive: type: boolean description: "Gets or sets the inactive flag for this shopping attribute\ \ group.\n " description: type: string description: "Gets or sets the description for this shopping attribute group.\n\ \ " maxLength: 128 minLength: 0 nullable: true name: type: string description: "Gets or sets the name for this shopping attribute group.\n\ \ " maxLength: 64 minLength: 0 nullable: true shoppingAttributeGroupCode: type: string description: "Gets or sets the code for this shopping attribute group.\n\ \ " maxLength: 8 minLength: 0 IJsonResponseOfShoppingAttributeGroup: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ShoppingAttributeGroup' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfShoppingAttribute: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ShoppingAttribute' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ShoppingAttribute: type: object description: "Model for a shopping attribute.\n " additionalProperties: false required: - shoppingAttributeCode properties: inActive: type: boolean description: "Gets or sets the flag for inactive for this shopping attribute.\n\ \ " description: type: string description: "Gets or sets the description of this shopping attribute.\n\ \ " maxLength: 128 minLength: 0 nullable: true name: type: string description: "Gets or sets the name of this shopping attribute.\n \ \ " maxLength: 64 minLength: 0 nullable: true shoppingAttributeCode: type: string description: "Gets or sets the code of this shopping attribute.\n \ \ " maxLength: 8 minLength: 0 shoppingAttributeGroupCodes: type: array description: "Gets or sets the list of group codes associated with this\ \ shopping attribute.\n " nullable: true items: type: string shoppingAttributeType: description: "Gets or sets the type of this shopping attribute.\n \ \ " $ref: '#/components/schemas/ShoppingAttributeType' ShoppingAttributeType: type: integer description: "Enumeration for shopping attribute types.\n \n\n0 =\ \ None\n1 = Destination\n2 = Region\n3 = Event" x-enumNames: - None - Destination - Region - Event enum: - 0 - 1 - 2 - 3 IJsonResponseOfShoppingAttribute: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ShoppingAttribute' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfSsrGroup: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/SsrGroup' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SsrGroup: type: object description: "The sell service request (SSR) group model.\n " additionalProperties: false properties: ssrGroupCode: type: string description: "The SSR group Code.\n " maxLength: 4 minLength: 1 nullable: true name: type: string description: "The Name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The in active.\n " ssrs: type: array description: "The Collection of SSRs.\n " nullable: true items: $ref: '#/components/schemas/SsrGroupItem' SsrGroupItem: type: object description: "The SSR group SSR model.\n " additionalProperties: false properties: ssrGroupCode: type: string description: "The SSR group Code.\n " maxLength: 4 minLength: 1 nullable: true ssrCode: type: string description: "The SSR Code.\n " maxLength: 4 minLength: 1 nullable: true IJsonResponseOfSsrGroup: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SsrGroup' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfSsrNest: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/SsrNest' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SsrNest: type: object description: "The SSR nest model.\n " additionalProperties: false properties: ssrNestCode: type: string description: "The SSR nest code.\n " maxLength: 4 minLength: 0 nullable: true name: type: string description: "The name.\n " maxLength: 64 minLength: 1 nullable: true inActive: type: boolean description: "The in active.\n " ssrs: type: array description: "The SSR.\n " nullable: true items: $ref: '#/components/schemas/Ssr' IJsonResponseOfSsrNest: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SsrNest' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfSsrRestrictionResult: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/SsrRestrictionResult' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SsrRestrictionResult: type: object description: "The SSR Restriction Result model.\n " additionalProperties: false properties: inActive: type: boolean description: "Gets or sets the inactive flag for this model.\n \ \ " ssrRestrictionResultCode: type: string description: "Gets or sets the code for this model\n " maxLength: 32 minLength: 0 nullable: true name: type: string description: "Gets or sets the name for this model.\n " maxLength: 64 minLength: 0 nullable: true IJsonResponseOfSsrRestrictionResult: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SsrRestrictionResult' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfSsr: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Ssr' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfSsr: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Ssr' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfStandByPriority: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/StandByPriority' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' StandByPriority: type: object description: "The stand by priority model.\n " additionalProperties: false properties: standByPriorityCode: type: string description: "The priority code.\n " nullable: true name: type: string description: "the name.\n " nullable: true priorityCategory: type: string description: "the priority category\n " nullable: true inActive: type: boolean description: "the in active.\n " IJsonResponseOfStandByPriority: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/StandByPriority' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfStationCategory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/StationCategory' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' StationCategory: type: object description: "The station category model.\n " additionalProperties: false properties: stationCategoryCode: type: string description: "The station category code.\nPlease note that this should be\ \ a char and not a string.\n " maxLength: 1 name: type: string description: "The name.\n " nullable: true inActive: type: boolean description: "THe in active.\n " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes\ \ endpoint to verify role based access instead.\n " IJsonResponseOfStationCategory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/StationCategory' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfStation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Station' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CreateStationRequest: type: object description: "Defines the create station request.\n " additionalProperties: false required: - inActive - fullName - shortName - currencyCode - cultureCode - latitude - longitude - zoneCode - subZoneCode - countryCode - cityCode - timeZoneCode - weightType - stationCode properties: inActive: type: boolean description: "The flag indicating if the station is inactive.\n \ \ " icaoCode: type: string description: "The International Civil Aviation Organization (ICAO) code\ \ for the station.\n " maxLength: 4 minLength: 0 nullable: true fullName: type: string description: "The full display name.\n " maxLength: 64 minLength: 0 shortName: type: string description: "The short display name.\n " maxLength: 32 minLength: 0 macCode: type: string description: "The MAC (Multiple Airport Code) code.\n " maxLength: 3 minLength: 0 nullable: true currencyCode: type: string description: "The default currency code.\n " maxLength: 3 minLength: 0 conversionCurrencyCode: type: string description: "The configured conversion currency code.\n " maxLength: 3 minLength: 0 nullable: true cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 stationClass: type: string description: "The configured class.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 latitude: type: string description: "The coordinates of the station.\n " maxLength: 10 minLength: 0 longitude: type: string description: "The coordinates of the station.\n " maxLength: 11 minLength: 0 zoneCode: type: string description: "The geographical location code (i.e. North America, Europe).\n\ \ " maxLength: 2 minLength: 0 subZoneCode: type: string description: "The sub zone code based on the geographical location (i.e.\ \ USA, Canada).\n " maxLength: 3 minLength: 0 countryCode: type: string description: "The country code the station exists in.\n " maxLength: 2 minLength: 0 provinceStateCode: type: string description: "The province or state the station exists in.\n " maxLength: 3 minLength: 0 nullable: true cityCode: type: string description: "The city the station exists in.\n " maxLength: 3 minLength: 0 timeZoneCode: type: string description: "The configured timezone of the station.\n " maxLength: 4 minLength: 0 thirdPartyControlled: type: boolean description: "The flag indicating if the station is controlled via a third\ \ party.\n " weightType: description: "The configured weight units of measurement.\n " $ref: '#/components/schemas/WeightType' stationCode: type: string description: "The station unique code.\n " maxLength: 3 minLength: 3 UpdateStationRequest: type: object description: "Defines the update station request.\n " additionalProperties: false required: - inActive - fullName - shortName - currencyCode - cultureCode - latitude - longitude - zoneCode - subZoneCode - countryCode - cityCode - timeZoneCode - weightType properties: inActive: type: boolean description: "The flag indicating if the station is inactive.\n \ \ " icaoCode: type: string description: "The International Civil Aviation Organization (ICAO) code\ \ for the station.\n " maxLength: 4 minLength: 0 nullable: true fullName: type: string description: "The full display name.\n " maxLength: 64 minLength: 0 shortName: type: string description: "The short display name.\n " maxLength: 32 minLength: 0 macCode: type: string description: "The MAC (Multiple Airport Code) code.\n " maxLength: 3 minLength: 0 nullable: true currencyCode: type: string description: "The default currency code.\n " maxLength: 3 minLength: 0 conversionCurrencyCode: type: string description: "The configured conversion currency code.\n " maxLength: 3 minLength: 0 nullable: true cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 stationClass: type: string description: "The configured class.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 latitude: type: string description: "The coordinates of the station.\n " maxLength: 10 minLength: 0 longitude: type: string description: "The coordinates of the station.\n " maxLength: 11 minLength: 0 zoneCode: type: string description: "The geographical location code (i.e. North America, Europe).\n\ \ " maxLength: 2 minLength: 0 subZoneCode: type: string description: "The sub zone code based on the geographical location (i.e.\ \ USA, Canada).\n " maxLength: 3 minLength: 0 countryCode: type: string description: "The country code the station exists in.\n " maxLength: 2 minLength: 0 provinceStateCode: type: string description: "The province or state the station exists in.\n " maxLength: 3 minLength: 0 nullable: true cityCode: type: string description: "The city the station exists in.\n " maxLength: 3 minLength: 0 timeZoneCode: type: string description: "The configured timezone of the station.\n " maxLength: 4 minLength: 0 thirdPartyControlled: type: boolean description: "The flag indicating if the station is controlled via a third\ \ party.\n " weightType: description: "The configured weight units of measurement.\n " $ref: '#/components/schemas/WeightType' DeltaMapperOfUpdateStationRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: inActive: type: boolean description: "The flag indicating if the station is inactive.\n \ \ " icaoCode: type: string description: "The International Civil Aviation Organization (ICAO) code\ \ for the station.\n " maxLength: 4 minLength: 0 nullable: true fullName: type: string description: "The full display name.\n " maxLength: 64 minLength: 0 shortName: type: string description: "The short display name.\n " maxLength: 32 minLength: 0 macCode: type: string description: "The MAC (Multiple Airport Code) code.\n " maxLength: 3 minLength: 0 nullable: true currencyCode: type: string description: "The default currency code.\n " maxLength: 3 minLength: 0 conversionCurrencyCode: type: string description: "The configured conversion currency code.\n " maxLength: 3 minLength: 0 nullable: true cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 stationClass: type: string description: "The configured class.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 latitude: type: string description: "The coordinates of the station.\n " maxLength: 10 minLength: 0 longitude: type: string description: "The coordinates of the station.\n " maxLength: 11 minLength: 0 zoneCode: type: string description: "The geographical location code (i.e. North America, Europe).\n\ \ " maxLength: 2 minLength: 0 subZoneCode: type: string description: "The sub zone code based on the geographical location (i.e.\ \ USA, Canada).\n " maxLength: 3 minLength: 0 countryCode: type: string description: "The country code the station exists in.\n " maxLength: 2 minLength: 0 provinceStateCode: type: string description: "The province or state the station exists in.\n " maxLength: 3 minLength: 0 nullable: true cityCode: type: string description: "The city the station exists in.\n " maxLength: 3 minLength: 0 timeZoneCode: type: string description: "The configured timezone of the station.\n " maxLength: 4 minLength: 0 thirdPartyControlled: type: boolean description: "The flag indicating if the station is controlled via a third\ \ party.\n " weightType: description: "The configured weight units of measurement.\n " $ref: '#/components/schemas/WeightType' IJsonResponseOfIListOfTimeZone: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/TimeZone' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TimeZone: type: object description: "The timezone model.\n " additionalProperties: false required: - timeZoneCode properties: inActive: type: boolean description: "Gets or sets the inactive flag for this time zone.\n \ \ " name: type: string description: "Gets or sets the name of this time zone.\n " maxLength: 64 minLength: 0 nullable: true standardVariation: type: integer description: "Gets or sets the standard variation of this time zone\n \ \ " timeZoneCode: type: string description: "Gets or sets the time zone code of this time zone.\n \ \ " maxLength: 4 minLength: 4 timeZoneVariations: type: array description: "Gets or sets a list of Time zone variations associated with\ \ this time zone.\n " nullable: true items: $ref: '#/components/schemas/TimeZoneVariation' TimeZoneVariation: type: object description: "The time zone variation model.\n " additionalProperties: false properties: endUtc: type: string description: "Gets or sets the End UTC time variation.\n " format: date-time nullable: true startUtc: type: string description: "Gets or sets the Start UTC time variation.\n " format: date-time nullable: true variation: type: integer description: "Gets or sets the variation.\n " IJsonResponseOfTimeZone: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/TimeZone' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfTravelClass: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/TravelClass' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TravelClass: type: object description: "This model represents the passenger summary info per cabin.\n\ \ " additionalProperties: false required: - name properties: travelClassCode: type: string description: "Gets or sets the code for this travel class.\n " nullable: true name: type: string description: "Gets or sets the name for this travel class.\n " maxLength: 64 minLength: 0 cabinOfServiceCode: type: string description: "Gets or sets the cabin of service code for this travel class.\n\ \ " nullable: true systemControlled: type: boolean description: "Gets or sets the system controlled flag for this travel class.\n\ \ " inActive: type: boolean description: "Gets or sets the inactive flag for this travel class.\n \ \ " IJsonResponseOfTravelClass: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/TravelClass' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfTravelerNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/TravelerNotification' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' TravelerNotification: type: object description: "Traveler notification model.\n " additionalProperties: false properties: createdUserKey: type: string description: "The created user key.\n " nullable: true createdDate: type: string description: "The date and time the object was created.\n " format: date-time nullable: true notificationTypeCode: type: string description: "Notification type code of the traveler notification.\n \ \ " nullable: true modifiedUserKey: type: string description: "The modified user key.\n " nullable: true modifiedDate: type: string description: "The date and time the object was modified.\n " format: date-time nullable: true name: type: string description: "The name of the traveler notification.\n " nullable: true deliveryMethods: type: array description: "The list of delivery methods for the traveler notification.\n\ \ " nullable: true items: $ref: '#/components/schemas/TravelerNotificationDeliveryMethod' TravelerNotificationDeliveryMethod: type: object description: "Traveler notification delivery method model.\n " additionalProperties: false properties: createdUserKey: type: string description: "The created user key.\n " nullable: true createdDate: type: string description: "The date and time the object was created.\n " format: date-time nullable: true notificationTypeCode: type: string description: "Notification type code of the traveler notification.\n \ \ " nullable: true modifiedUserKey: type: string description: "The modified user key.\n " nullable: true modifiedDate: type: string description: "The date and time the object was modified.\n " format: date-time nullable: true allowForAnonymous: type: boolean description: "Gets or sets if the traveler notification is allowed for anonymous\ \ user.\n " allowForCustomer: type: boolean description: "Gets or sets if the traveler notification is allowed for customer.\n\ \ " allowForPassenger: type: boolean description: "Gets or sets if the traveler notification is allowed for passenger.\n\ \ " deliveryMethodCode: type: string description: "Delivery method code of the traveler notification.\n \ \ " nullable: true inActive: type: boolean description: "Gets or sets the inactive flag.\n " programCode: type: string description: "The program code.\n " nullable: true programLevel: type: string description: "The program level.\n " nullable: true IJsonResponseOfTravelerNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/TravelerNotification' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfNotificationDeliveryMethod: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/NotificationDeliveryMethod' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' NotificationDeliveryMethod: type: object description: "Notification delivery method model.\n " additionalProperties: false properties: createdUserKey: type: string description: "The created user key.\n " nullable: true createdDate: type: string description: "The date and time the object was created.\n " format: date-time nullable: true notificationTypeCode: type: string description: "Notification type code of the traveler notification.\n \ \ " nullable: true modifiedUserKey: type: string description: "The modified user key.\n " nullable: true modifiedDate: type: string description: "The date and time the object was modified.\n " format: date-time nullable: true name: type: string description: "The name of the notification delivery method.\n \ \ " nullable: true contentType: description: "The content type of the notification delivery method.\n \ \ " $ref: '#/components/schemas/NotificationContentType' maximumSubscription: type: integer description: "The maximum number of notification subscriptions allowed for\ \ this notification delivery method type.\nA number of 0 indicates no\ \ limit to the number of subscriptions allowed.\n " NotificationContentType: type: integer description: "Represents the notification content format type.\n \ \ \n\n0 = XML\n1 = JSON" x-enumNames: - XML - JSON enum: - 0 - 1 IJsonResponseOfIListOfTravelerNotificationDeliveryMethod: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/TravelerNotificationDeliveryMethod' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfExternalSystem: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ExternalSystem' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfCountryv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Countryv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Countryv2: type: object description: "Represents the country model, version two.\n " additionalProperties: false required: - countryCode - countryCode3C properties: countryCode: type: string description: "Represents the two-digit country code.\n " maxLength: 2 minLength: 1 countryCode3C: type: string description: "Represents the three-digit country code.\n " maxLength: 3 minLength: 1 cities: type: array description: "Gets or sets the list of cities in this country.\n \ \ " nullable: true items: $ref: '#/components/schemas/City' defaultCurrencyCode: type: string description: "Gets or sets the default currency code of this country.\n\ \ " maxLength: 3 minLength: 1 nullable: true hasProvinceStates: type: boolean description: "Gets or sets whether this country has province states.\n \ \ " inActive: type: boolean description: "Gets or sets whether this country is active.\n " name: type: string description: "Gets or sets the name of this country.\n " maxLength: 64 minLength: 0 nullable: true provinceStates: type: array description: "Gets or sets the province states for this country.\n \ \ " nullable: true items: $ref: '#/components/schemas/ProvinceState' IJsonResponseOfCountryv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Countryv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfCurrencyv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Currencyv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfCurrencyv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Currencyv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfMac: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Mac' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfMarketv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Marketv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Marketv2: type: object description: "The market model, version 2.\n " additionalProperties: false required: - locationCode - travelLocationCode properties: locationCode: type: string description: "The starting location code for this market.\n " maxLength: 3 minLength: 0 earliestCheckInFrom: type: integer description: "The earliest check in from travel location for this market.\n\ \ " format: int32 earliestCheckInTo: type: integer description: "The earliest check in to travel location for this market.\n\ \ " format: int32 inActive: type: boolean description: "The inactive flag for this market.\n " includesTaxesAndFees: description: "The directions where taxes and fees are included in this market.\n\ \ " $ref: '#/components/schemas/Directionality' latestCheckInFrom: type: integer description: "The latest check in from travel location for this market.\n\ \ " format: int32 latestCheckInTo: type: integer description: "The latest check in to travel location for this market.\n\ \ " format: int32 locationType: description: "The location type of the starting location for this market.\n\ \ " $ref: '#/components/schemas/MarketLocationType' travelLocationCode: type: string description: "The ending location code for this market.\n " maxLength: 3 minLength: 0 travelLocationType: description: "The location type of the ending location for this market.\n\ \ " $ref: '#/components/schemas/MarketLocationType' travelLocationsRequired: description: "The market rules for requiring travel documents for this market.\n\ \ " $ref: '#/components/schemas/TravelLocationsRequired' MarketLocationType: type: integer description: "Enum representing the type of location of a market point.\n \ \ \n\n0 = Undefined\n1 = Station\n3 = Mac" x-enumNames: - Undefined - Station - Mac enum: - 0 - 1 - 3 TravelLocationsRequired: type: integer description: "Enum representing when travel documents are required in a market.\n\ \ \n\n0 = None\n1 = FromTravel\n2 = ToTravel\n3 = BothTravel" x-enumNames: - None - FromTravel - ToTravel - BothTravel enum: - 0 - 1 - 2 - 3 IJsonResponseOfListOfMarketv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Marketv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfMarketv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Marketv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfBookingPaymentSettingsv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BookingPaymentSettingsv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingPaymentSettingsv2: type: object description: "The booking payment settings.\n " additionalProperties: false properties: allowExternalPaymentChargeBack: type: boolean description: "The flag to allow approved external payment charge back.\n\ \ " allowHoldDateOverride: type: boolean description: "The flag to allow overriding the hold dates.\n " allowIgnoreVoucherRestrictions: type: boolean description: "The flag to allow ignoring voucher restrictions.\n \ \ " allowVoucherIssuance: type: boolean description: "The flag to allow issuing vouchers.\n " allowManualAuthorization: type: boolean description: "The flag to manually authorize credit cards.\n " allowOverPay: type: boolean description: "The flag to allow overpayment.\n " allowUnderPay: type: boolean description: "The flag to allow underpayment.\n " allowUnvoidVoucher: type: boolean description: "The flag to allow unvoiding vouchers.\n " allowUseOfBinFraudTool: type: boolean description: "The flag to allow use of BIN fraud tool.\n " allowVoidVoucher: type: boolean description: "The flag to allow voided vouchers.\n " enableAutoPaymentVerification: type: boolean description: "The flag to enable auto-payment verification.\n \ \ " allowConfirmBookingWithPartialTicketing: type: boolean description: "The flag to allow confirming booking with partial ticketing.\n\ \ " allowUnmaskingCreditCardNumber: type: boolean description: "The flag to allow displaying the full credit card number without\ \ masking.\n " allowDisplayNoPaymentWarning: type: boolean description: "The flag to allow displaying a no payment warning.\n \ \ " requirePassengerOrContactForCreditFile: type: boolean description: "The flag to require passengers or contacts for a credit file.\n\ \ " requirePassengerOrContactForCreditShell: type: boolean description: "The flag to require passengers or contacts for a credit shell.\n\ \ " requireCommentsForCreditShell: type: boolean description: "The flag to require comments for credit shell.\n \ \ " disableAlternateAgAccount: type: boolean description: "The flag to disable alternative AG accounts.\n " creditShellCreditCode: type: string description: "The credit shell credit code.\n " nullable: true maxInstallmentOverride: type: integer description: "Gets or sets a max number of installment overrides.\n \ \ " format: int32 maximum: 999.0 minimum: 0.0 maxPaymentQueries: type: integer description: "The max number of payment queries.\n " format: int32 maximum: 10000.0 minimum: 1.0 secondsTillStartPaymentQuery: type: integer description: "The number of seconds till the payment query starts.\n \ \ " format: int32 maximum: 10000.0 minimum: 2.0 secondsTillRepeatPaymentQuery: type: integer description: "The number of seconds till the payment query repeats.\n \ \ " format: int32 maximum: 10000.0 minimum: 3.0 holdsDaysBeforeDeparture: type: string description: "The duration for a hold before booking date.\n " format: duration nullable: true holdsDaysAfterDeparture: type: string description: "The duration for a hold after booking date.\n " format: duration nullable: true allowPendingCustomerActionAuthorization: type: boolean description: "The flag to allow authorization of a pending customer action\ \ payment.\n " allowManualAuthorizationOfPendingPaymentWithoutValidation: type: boolean description: "Indicates whether the user is allowed to approve payments\n\ with Pending status.\n " maskPaymentFields: type: boolean description: "Mask the payment fields.\n " allowManualAuthorizationOfPaymentStatuses: type: array description: "The collection of payment status that can be manually authorized.\n\ \ " nullable: true items: $ref: '#/components/schemas/BookingPaymentStatus' displayVoucherNumber: type: boolean description: "Display the voucher reference number.\n " allowOverPayWithVoucherPayment: type: boolean description: "Whether to allow overpayment with the voucher payment method.\n\ \ " nullable: true allowVoucherOwnerUpdate: type: boolean description: "Indicates whether the user is allowed to update the voucher\ \ owner.\n " nullable: true DeltaMapperOfBookingPaymentSettingsv2: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: allowExternalPaymentChargeBack: type: boolean description: "The flag to allow approved external payment charge back.\n\ \ " allowHoldDateOverride: type: boolean description: "The flag to allow overriding the hold dates.\n " allowIgnoreVoucherRestrictions: type: boolean description: "The flag to allow ignoring voucher restrictions.\n \ \ " allowVoucherIssuance: type: boolean description: "The flag to allow issuing vouchers.\n " allowManualAuthorization: type: boolean description: "The flag to manually authorize credit cards.\n " allowOverPay: type: boolean description: "The flag to allow overpayment.\n " allowUnderPay: type: boolean description: "The flag to allow underpayment.\n " allowUnvoidVoucher: type: boolean description: "The flag to allow unvoiding vouchers.\n " allowUseOfBinFraudTool: type: boolean description: "The flag to allow use of BIN fraud tool.\n " allowVoidVoucher: type: boolean description: "The flag to allow voided vouchers.\n " enableAutoPaymentVerification: type: boolean description: "The flag to enable auto-payment verification.\n \ \ " allowConfirmBookingWithPartialTicketing: type: boolean description: "The flag to allow confirming booking with partial ticketing.\n\ \ " allowUnmaskingCreditCardNumber: type: boolean description: "The flag to allow displaying the full credit card number without\ \ masking.\n " allowDisplayNoPaymentWarning: type: boolean description: "The flag to allow displaying a no payment warning.\n \ \ " requirePassengerOrContactForCreditFile: type: boolean description: "The flag to require passengers or contacts for a credit file.\n\ \ " requirePassengerOrContactForCreditShell: type: boolean description: "The flag to require passengers or contacts for a credit shell.\n\ \ " requireCommentsForCreditShell: type: boolean description: "The flag to require comments for credit shell.\n \ \ " disableAlternateAgAccount: type: boolean description: "The flag to disable alternative AG accounts.\n " creditShellCreditCode: type: string description: "The credit shell credit code.\n " nullable: true maxInstallmentOverride: type: integer description: "Gets or sets a max number of installment overrides.\n \ \ " format: int32 maximum: 999.0 minimum: 0.0 maxPaymentQueries: type: integer description: "The max number of payment queries.\n " format: int32 maximum: 10000.0 minimum: 1.0 secondsTillStartPaymentQuery: type: integer description: "The number of seconds till the payment query starts.\n \ \ " format: int32 maximum: 10000.0 minimum: 2.0 secondsTillRepeatPaymentQuery: type: integer description: "The number of seconds till the payment query repeats.\n \ \ " format: int32 maximum: 10000.0 minimum: 3.0 holdsDaysBeforeDeparture: type: string description: "The duration for a hold before booking date.\n " format: duration nullable: true holdsDaysAfterDeparture: type: string description: "The duration for a hold after booking date.\n " format: duration nullable: true allowPendingCustomerActionAuthorization: type: boolean description: "The flag to allow authorization of a pending customer action\ \ payment.\n " allowManualAuthorizationOfPendingPaymentWithoutValidation: type: boolean description: "Indicates whether the user is allowed to approve payments\n\ with Pending status.\n " maskPaymentFields: type: boolean description: "Mask the payment fields.\n " allowManualAuthorizationOfPaymentStatuses: type: array description: "The collection of payment status that can be manually authorized.\n\ \ " nullable: true items: $ref: '#/components/schemas/BookingPaymentStatus' displayVoucherNumber: type: boolean description: "Display the voucher reference number.\n " allowOverPayWithVoucherPayment: type: boolean description: "Whether to allow overpayment with the voucher payment method.\n\ \ " nullable: true allowVoucherOwnerUpdate: type: boolean description: "Indicates whether the user is allowed to update the voucher\ \ owner.\n " nullable: true IJsonResponseOfIListOfSubZonev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/SubZonev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SubZonev2: type: object description: "The version two of the subzone model.\n " additionalProperties: false required: - subZoneCode - zoneCode properties: name: type: string description: "Gets or sets the name of this subzone.\n " maxLength: 64 minLength: 0 nullable: true subZoneCode: type: string description: "Gets or sets the subzone code for this subzone.\n \ \ " maxLength: 3 minLength: 1 zoneCode: type: string description: "Gets or sets the zone code for this subzone.\n " maxLength: 2 minLength: 1 IJsonResponseOfSubZonev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SubZonev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfZonev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Zonev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Zonev2: type: object description: "The version two of the zone model.\n " additionalProperties: false required: - areaCode - zoneCode properties: areaCode: type: string description: "Gets or sets the area code of this zone.\n " maxLength: 3 minLength: 1 name: type: string description: "Gets or sets the name of this zone.\n " maxLength: 64 minLength: 0 nullable: true zoneCode: type: string description: "Gets or sets the zone code of this zone.\n " maxLength: 2 minLength: 1 IJsonResponseOfZonev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Zonev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfBundleConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BundleConfiguration' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BundleConfiguration: type: object description: "The bundle configuration model.\n " additionalProperties: false properties: bundleCode: type: string description: "The service bundle code.\n " maxLength: 4 minLength: 0 nullable: true feeCode: type: string description: "The SSR fee code.\n " maxLength: 6 minLength: 0 nullable: true bookingQueueCode: type: string description: "The booking queue code.\n " maxLength: 6 minLength: 0 nullable: true programCode: type: string description: "The program code.\n " maxLength: 3 minLength: 0 nullable: true programLevel: type: string description: "The program code.\n " maxLength: 3 minLength: 0 nullable: true name: type: string description: "The bundle name.\n " maxLength: 64 minLength: 0 nullable: true description: type: string description: "The bundle description.\n " maxLength: 128 minLength: 0 nullable: true hasPrice: type: boolean description: "Indicates if the bundle type has a cost associated with it.\n\ \ " rank: type: integer description: "The bundle rank.\n " maximum: 32767.0 minimum: 1.0 inActive: type: boolean description: "Indicates if the bundle is active.\n " allSsrsRequired: type: boolean description: "Indicates if all SSR's are required.\n " serviceBundleType: description: "The type of the bundle\n " $ref: '#/components/schemas/ServiceBundleType' IJsonResponseOfBundleConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/BundleConfiguration' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfBundleSsrConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BundleSsrConfiguration' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BundleSsrConfiguration: type: object description: "The bundle ssr configuration model.\n " additionalProperties: false properties: ssrCode: type: string description: "The ssr code.\n " maxLength: 4 minLength: 0 nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true discountPercent: type: number description: "The discount percent.\n " format: decimal maximum: 1.0 minimum: 0.0 ssrNumber: type: integer description: "The SSR number.\n " isFeeWaived: type: boolean description: "Indicates if the service fee is waived.\n " amounts: type: array description: "The service bundle SSR discount amounts.\n " nullable: true items: $ref: '#/components/schemas/BundleDiscountAmount' bundleCode: type: string description: "The service bundle code.\n " maxLength: 4 minLength: 0 nullable: true upgradeFromSsrCode: type: string description: "The ssr code that was upgraded.\n " maxLength: 4 minLength: 0 nullable: true bundleSsrType: description: "The bundle ssr type.\n " $ref: '#/components/schemas/BundleSsrType' BundleSsrType: type: integer description: "The service bundle ssr enumeration.\n \n\n0 = InBundle\n\ 1 = InBundleUpgrade\n2 = NotInBundle\n3 = InBundleSeat" x-enumNames: - InBundle - InBundleUpgrade - NotInBundle - InBundleSeat enum: - 0 - 1 - 2 - 3 IJsonResponseOfIListOfBundleRule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BundleRule' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BundleRule: type: object description: "The bundle rule model.\n " additionalProperties: false properties: bundleRuleCode: type: string description: "The bundle rule code.\n " maxLength: 4 minLength: 0 nullable: true name: type: string description: "The bundle rule name.\n " maxLength: 64 minLength: 0 nullable: true IJsonResponseOfIListOfBundleSet: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BundleSet' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BundleSet: type: object description: "The bundle set model.\n " additionalProperties: false properties: bundleSetCode: type: string description: "The service bundle code.\n " maxLength: 4 minLength: 0 nullable: true name: type: string description: "The bundle set name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "Indicates if the set is inactive or not.\n " bundleCodes: type: array description: "The collection of bundle codes associated with the bundle\ \ set.\n " nullable: true items: type: string IJsonResponseOfIListOfCommissionRate: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/CommissionRate' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CommissionRate: type: object description: "The commission rate model.\n " additionalProperties: false required: - commissionRateCode properties: commissionRateCode: type: string description: "The commission rate code.\n " maxLength: 8 minLength: 0 name: type: string description: "The name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The in active.\n " IJsonResponseOfCommissionRate: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CommissionRate' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfContactType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ContactType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ContactType: type: object description: "The booking contact type.\n " additionalProperties: false required: - contactTypeCode properties: contactTypeCode: type: string description: "The type code.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 minLength: 1 inActive: type: boolean description: "The in active.\n " name: type: string description: "The name of the type.\n " maxLength: 64 minLength: 0 nullable: true IJsonResponseOfContactType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ContactType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfCustomerProgram: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/CustomerProgram' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CustomerProgram: type: object description: "The customer program such as loyalty programs.\n " additionalProperties: false properties: programCode: type: string description: "The program code.\n " maxLength: 3 minLength: 0 nullable: true name: type: string description: "The name.\n " maxLength: 64 minLength: 0 nullable: true programType: description: "The program type.\n " $ref: '#/components/schemas/ProgramType' validationType: type: string description: "The validation type.\n " nullable: true inActive: type: boolean description: "Is in-active.\n " qualifyingSegments: type: integer description: "The qualifying segments.\n " qualifyingPoints: type: integer description: "The qualifying points.\n " format: int32 pointBalance: type: integer description: "The point balance.\n " format: int32 customerProgramLevels: type: array description: "The customer program levels.\n " nullable: true items: $ref: '#/components/schemas/CustomerProgramLevel' ProgramType: type: integer description: "The program type enumeration.\n \n\n0 = Default\n1\ \ = Internal\n2 = External" x-enumNames: - Default - Internal - External enum: - 0 - 1 - 2 CustomerProgramLevel: type: object description: "The customer program level.\n " additionalProperties: false properties: programCode: type: string description: "The program code.\n " maxLength: 3 minLength: 0 nullable: true programLevelCode: type: string description: "The program level.\n " maxLength: 3 minLength: 0 nullable: true name: type: string description: "The name.\n " maxLength: 64 minLength: 0 nullable: true shortName: type: string description: "The short name.\n " maxLength: 32 minLength: 0 nullable: true displayCode: type: string description: "The display code.\n " maxLength: 1 minLength: 0 nullable: true rank: type: integer description: "The rank.\n " maximum: 32767.0 minimum: 0.0 inActive: type: boolean description: "The in active flag.\n " customerProgramSettings: type: array description: "The list of customer program settings.\n " nullable: true items: $ref: '#/components/schemas/CustomerProgramSetting' CustomerProgramSetting: type: object description: "The customer program setting.\n " additionalProperties: false properties: programCode: type: string description: "The program code.\n " maxLength: 3 minLength: 0 nullable: true programLevel: type: string description: "The program level.\n " maxLength: 3 minLength: 0 nullable: true settingCode: type: string description: "The setting code.\n " maxLength: 16 minLength: 0 nullable: true sequenceNumber: type: integer description: "The sequence number.\n " maximum: 32767.0 minimum: 0.0 settingValue: type: string description: "The setting value.\n " maxLength: 64 minLength: 0 nullable: true IJsonResponseOfCustomerProgram: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CustomerProgram' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfCustomerProgramLevel: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CustomerProgramLevel' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfDepartment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Department' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Department: type: object description: "The department model.\n " additionalProperties: false properties: departmentCode: type: string description: "The department code.\n " maxLength: 4 minLength: 0 nullable: true name: type: string description: "The department name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The in active.\n " IJsonResponseOfDepartment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Department' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfDocumentType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/DocumentType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' DocumentType: type: object description: "The document type model.\n " additionalProperties: false required: - documentTypeCode properties: documentTypeCode: type: string description: "The document type code.\n " minLength: 1 name: type: string description: "The document type name.\n " nullable: true group: description: "The document group.\n " $ref: '#/components/schemas/DocumentGroup' isExpirationDateRequired: type: boolean description: "Indicates if an expiration date is required.\n " inActive: type: boolean description: "The in active.\n " IJsonResponseOfDocumentType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/DocumentType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfDomain: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Domain' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Domain: type: object description: "The domain model.\n " additionalProperties: false required: - domainCode properties: domainCode: type: string description: "The domain code.\n " maxLength: 3 minLength: 0 name: type: string description: "The domain name.\n " maxLength: 64 minLength: 0 pattern: ^[^\[\]]*$ nullable: true passwordNeverExpires: type: boolean description: "Set to true if the password will never expire.\n \ \ " minimumPasswordAge: type: integer description: "Minimum Password Age is the amount of days that a password\ \ must live before it can be\nchanged. This is to prevent an Agent from\ \ changing their password the required amount\nof times so that the system\ \ allows her to return to her original password. For\nexample, if my pwd\ \ (12345) expires, and I don't want to change it, without this\nMinimum\ \ Password Age I could change it manually the right number of times and\ \ then\nchange it back to 12345, thus defeating the purpose of requiring\ \ the change in the\nfirst place.\nIf the field is set to null, the system\ \ should never prevent an\nAgent from changing her password. The example\ \ above would be perfectly valid.\n " maximum: 32767.0 minimum: 1.0 nullable: true maximumPasswordAge: type: integer description: "The Maximum Password Age is the amount of time a password\ \ can live before the system\nforces it to be changed. If this is set\ \ to null, the system\nwould never force an Agent to change their password.\n\ \ " maximum: 32767.0 minimum: 1.0 nullable: true maximumFaliedLogons: type: integer description: "After failing logon the amount of times specified by this\ \ field the locked bit is\nflipped on the Agent. No more logon attempts\ \ from the UI will be accepted for that\nAgent name. This locked bit can\ \ be flipped (on or off) manually in the Agents dialog\nin SkyManager.\n\ Setting this field to null would also indicate that logon can be\nattempted\ \ an unlimited amount of times for an Agent.\n " maximum: 32767.0 minimum: 1.0 nullable: true uniquePasswordCount: type: integer description: "The system forces the Agent to not re-use a password that\ \ it remembers the Agent has\nused. This field defines how many passwords\ \ the system remembers for an Agent. So if\nthis field is set to two and\ \ if my password was 12345, then when my password is\nchanged I would\ \ have to have two other passwords before I could reuse 12345.\nThis field\ \ does NOT specify how many Agents can have the same password. As far\ \ as the\nsystem is concerned every Agent can have the same password.\n\ \ " maximum: 32767.0 minimum: 1.0 nullable: true passwordPolicy: description: "The password policy.\n " nullable: true $ref: '#/components/schemas/RegularExpressionPolicy' usernamePolicy: description: "The regular expression that defines the rules for the username\ \ policy.\n " nullable: true $ref: '#/components/schemas/RegularExpressionPolicy' allowed: type: boolean description: "True if the domain is allowed to use.\n " useNewResetPasswordFlow: type: boolean description: "Indicates whether the agents in the domain are allowed to\ \ use the new reset password flow.\n " challengeCodeContactMethod: description: "Indicates the required contact method for sending challenge\ \ codes.\n " $ref: '#/components/schemas/ChallengeCodeContactMethod' maximumFailedPasswordResets: type: integer description: "The number of times the agent can fail within the password\ \ reset flow before they are placed into a sandbag state.\nThe sandbag\ \ state is when the user will not be able to attempt another password\ \ reset for a specified amount of\ntime.\n " nullable: true challengeCodeExpirationMinutes: type: integer description: "The time in minutes before a challenge code expires.\n \ \ " nullable: true failedPasswordResetMinutes: type: integer description: "The number of minutes the agent will be required to wait if\ \ they exceed the maximum allowed failed password resets.\n \ \ " nullable: true RegularExpressionPolicy: type: object description: "The model describing regular expression policies for a string.\n\ \ " additionalProperties: false required: - policy properties: policy: type: string description: "The regular expression policy that will be evaluated.\n \ \ " maxLength: 128 minLength: 0 description: type: string description: "The policy description.\n " maxLength: 256 minLength: 0 nullable: true ChallengeCodeContactMethod: type: integer description: "Indicates the required contact method for sending challenge codes.\n\ \ \n\n0 = None\n1 = Email\n2 = Phone\n3 = All" x-enumNames: - None - Email - Phone - All enum: - 0 - 1 - 2 - 3 IJsonResponseOfDomain: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Domain' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfEmailType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/EmailType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' EmailType: type: object description: "The email type.\n " additionalProperties: false required: - emailTypeCode properties: emailTypeCode: type: string description: "The email type code.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 minLength: 1 name: type: string description: "The type name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The InActive.\n " dataSchema: type: string description: "The data schema.\n " maxLength: 2147483647 minLength: 0 nullable: true IJsonResponseOfEmailType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/EmailType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPassengerDiscount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerDiscount' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerDiscount: type: object description: "The passenger discount model.\n " additionalProperties: false properties: passengerDiscountCode: type: string description: "The passenger discount code.\n " maxLength: 4 minLength: 1 nullable: true name: type: string description: "The Name.\n " maxLength: 64 minLength: 0 nullable: true passengerDiscountType: description: "The passenger discount type.\n " $ref: '#/components/schemas/PassengerDiscountType' inActive: type: boolean description: "The in active.\n " allowed: type: boolean description: "The allowed.\n " PassengerDiscountType: type: integer description: "Passenger discount type enumeration.\n \n\n0 = Default\n\ 1 = Regular\n2 = Loyalty" x-enumNames: - Default - Regular - Loyalty enum: - 0 - 1 - 2 IJsonResponseOfPassengerDiscount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerDiscount' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPassengerType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PassengerType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PassengerType: type: object description: "The passenger type model.\n " additionalProperties: false required: - passengerTypeCode properties: nonAdult: type: boolean description: "The non-adult for the passenger type.\n " passengerTypeCode: type: string description: "The code for the passenger type.\n " maxLength: 4 minLength: 1 name: type: string description: "The name for the passenger type.\n " maxLength: 64 minLength: 0 nullable: true allowed: type: boolean description: "The allowed flag for the passenger type.\n " inActive: type: boolean description: "The inactive flag for the passenger type.\n " typeIndicator: description: "The type indicator specifying the age group this belongs to.\n\ \ " $ref: '#/components/schemas/PassengerTypeIndicator' minimumAge: type: integer description: "The minimum age for the passenger type.\n " maximumAge: type: integer description: "The maximum age for the passenger type.\n " PassengerTypeIndicator: type: integer description: "Passenger type indicator.\n \n\n0 = Adult\n1 = Infant\n\ 2 = Child\n3 = NonAdult" x-enumNames: - Adult - Infant - Child - NonAdult enum: - 0 - 1 - 2 - 3 IJsonResponseOfPassengerType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PassengerType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPersonInformationType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonInformationType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonInformationType: type: object description: "The person information type model.\n " additionalProperties: false required: - personInformationTypeCode properties: personInformationTypeCode: type: string description: "The person information type code.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 minLength: 1 name: type: string description: "The name of the type.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "Is in-active.\n " schema: type: string description: "The data schema of person info type.\n " maxLength: 2147483647 minLength: 0 nullable: true IJsonResponseOfPersonInformationType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonInformationType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPhoneType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PhoneType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PhoneType: type: object description: "The phone type.\n " additionalProperties: false required: - phoneTypeCode properties: phoneTypeCode: type: string description: "The type code.\nPlease note that this should be a char and\ \ not a string.\n " maxLength: 1 minLength: 1 name: type: string description: "The Name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "Is InActive.\n " type: description: "The enum value.\n " $ref: '#/components/schemas/PhoneNumberType' IJsonResponseOfPhoneType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PhoneType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfRoleSettingType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/RoleSettingType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' RoleSettingType: type: object description: "The role settings type model.\n " additionalProperties: false required: - roleSettingTypeCode properties: roleSettingTypeCode: type: string description: "The code for the role setting type.\n " maxLength: 20 minLength: 0 name: type: string description: "The name for the role setting type.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The inactive flag for this setting type.\n " IJsonResponseOfRoleSettingType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/RoleSettingType' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfAgencyCreationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AgencyCreationSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AgencyCreationSettings: type: object description: "Settings for creating agencies.\n " additionalProperties: false properties: department: type: string description: "The default Department for new agency.\n " maxLength: 4 minLength: 0 nullable: true role: type: string description: "The default Role for new agency.\n " maxLength: 4 minLength: 1 nullable: true domainCode: type: string description: "The default Domain for new agency.\n " maxLength: 5 minLength: 0 nullable: true domainName: type: string description: "The default Domain name for new agency.\n " nullable: true domainLocation: type: string description: "The default domain Location value for new agency.\n \ \ " nullable: true channelType: description: "The default channel type for new agency.\n " $ref: '#/components/schemas/ChannelType' notificationEmailAddress: type: string description: "The default notification email address for new agency.\n \ \ " nullable: true masterRole: type: string description: "The default master role for the new agency.\n " nullable: true phoneType: description: "The default phone type for the new agency.\n " $ref: '#/components/schemas/PhoneNumberType' IJsonResponseOfCustomerCreationSettings: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CustomerCreationSettings' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CustomerCreationSettings: type: object description: "Settings for creating customers.\n " additionalProperties: false properties: organization: type: string description: "Gets or sets the default Customer organization for new customer.\n\ \ " maxLength: 10 minLength: 0 nullable: true domain: type: string description: "Gets or sets the default Domain for new customer.\n \ \ " maxLength: 5 minLength: 0 nullable: true department: type: string description: "Gets or sets the default Department for new customer.\n \ \ " maxLength: 4 minLength: 0 nullable: true role: type: string description: "Gets or sets the default Role for new customer.\n \ \ " maxLength: 4 minLength: 1 nullable: true location: type: string description: "Gets or sets the default Location value for new customer.\n\ \ " maxLength: 5 minLength: 0 nullable: true minimumAge: type: integer description: "Gets or sets the minimum age for a new customer.\n \ \ " format: int32 maximum: 32767.0 minimum: 0.0 enableCheckDigit: type: boolean description: "Gets or sets the flag that enables the check digit algorithm.\n\ \ " allowPropertyBagUpload: type: boolean description: "Gets or sets the flag that allows bag property uploads.\n\ \ " maximumPersonInfoSize: type: integer description: "Gets or sets the maximum size of the person info.\n \ \ " format: int64 nullable: true allowDuplicateCustomerName: type: boolean description: "Gets or sets the flag allowing duplicate customer names.\n\ \ " IJsonResponseOfIListOfSuffix: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Suffix' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Suffix: type: object description: "The suffix model.\n " additionalProperties: false required: - suffixCode properties: suffixCode: type: string description: "The suffix code.\n " minLength: 1 name: type: string description: "The name.\n " nullable: true inActive: type: boolean description: "Is InActive.\n " IJsonResponseOfSuffix: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Suffix' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfTitle: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Title' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Title: type: object description: "Defines the title that can be associated to an individual or object\ \ (passenger, person, etc.).\n " additionalProperties: false properties: titleKey: type: string description: "The unique identifier of the title.\n " maxLength: 6 minLength: 1 nullable: true description: type: string description: "Short description about the title.\n " maxLength: 128 minLength: 0 nullable: true gender: description: "The binary gender associated with the title.\n " $ref: '#/components/schemas/Gender' weightCategory: description: "The weight category.\n " $ref: '#/components/schemas/WeightCategory' inActive: type: boolean description: "Indicates if the title is active or inactive.\n \ \ " declaredGender: type: string description: "The non-binary gender associated with the title.\n \ \ " nullable: true IJsonResponseOfTitle: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Title' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfCustomerProgramv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/CustomerProgramv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' CustomerProgramv2: type: object description: "The customer program such as loyalty programs.\n " additionalProperties: false properties: programCode: type: string description: "The program code.\n " maxLength: 3 minLength: 0 nullable: true name: type: string description: "The name.\n " maxLength: 64 minLength: 0 nullable: true programType: description: "The program type.\n " $ref: '#/components/schemas/ProgramType' inActive: type: boolean description: "Indicates if the customer program is active or inactive.\n\ \ " customerProgramLevels: type: array description: "The customer program levels.\n " nullable: true items: $ref: '#/components/schemas/CustomerProgramLevel' checkDigitType: description: "The check digit type validation to apply.\n " $ref: '#/components/schemas/CheckDigitType' CheckDigitType: type: integer description: "Defines the check digit types.\n \n\n0 = Other\n1 =\ \ None\n2 = Mod10\n3 = Mod10i\n4 = IACO9093\n5 = NavitaireLoyalty" x-enumNames: - Other - None - Mod10 - Mod10i - IACO9093 - NavitaireLoyalty enum: - 0 - 1 - 2 - 3 - 4 - 5 IJsonResponseOfCustomerProgramv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/CustomerProgramv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ServerTransferRequest: type: object description: "Represents a server transfer request.\n " additionalProperties: false required: - serverContextToken properties: serverContextToken: type: string description: "The NewSkies server context token to transfer.\n \ \ " minLength: 1 applicationName: type: string description: "The optional application name.\n " nullable: true channel: description: "The transferred server's channel type.\n " nullable: true $ref: '#/components/schemas/ChannelType' newSession: type: boolean description: "Create a new session and keep the old one alive.\n \ \ " IJsonResponseOfIListOfBookingTripResult: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/BookingTripResult' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' BookingTripResult: type: object description: "Booking flight result data.\n " additionalProperties: false properties: recordLocator: type: string description: "The record locator.\n " nullable: true bookingStatus: description: "The booking status.\n " $ref: '#/components/schemas/BookingStatus' priceStatus: description: "The price status.\n " $ref: '#/components/schemas/PriceStatus' paidStatus: description: "The paid status.\n " $ref: '#/components/schemas/PaidStatus' createdDate: type: string description: "The UTC date and time of when the booking was created.\n \ \ " format: date-time nullable: true firstName: type: string description: "The first name on the booking.\n " nullable: true lastName: type: string description: "The last name on the booking.\n " nullable: true customerNumber: type: string description: "The customer number on the booking.\n " nullable: true segments: type: array description: "The applicable segments.\n " nullable: true items: $ref: '#/components/schemas/SegmentTripResult' SegmentTripResult: type: object description: "Model data.\n " additionalProperties: false properties: designator: description: "This is a summary of all the legs on the segment. It will\ \ contain the details\nof the transportation from the first and last leg.\n\ \ " nullable: true $ref: '#/components/schemas/TransportationDesignator' classOfService: type: string description: "The class of service.\n " maxLength: 8 minLength: 0 nullable: true activityDate: type: string description: "The activity date.\n " format: date-time nullable: true identifier: description: "The transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' externalIdentifier: description: "The external transportation identifier.\n " nullable: true $ref: '#/components/schemas/TransportationIdentifier' legs: type: array description: "The associated leg information.\n " nullable: true items: $ref: '#/components/schemas/LegTripResult' journeyIndex: type: integer description: "The journey index the segment is related to relative to the\ \ booking.\n " segmentIndex: type: integer description: "The segment index the segment is related to relative to the\ \ booking.\n " LegTripResult: type: object description: "Model data.\n " additionalProperties: false properties: designator: description: "Transportation information.\n " nullable: true $ref: '#/components/schemas/TransportationDesignator' boardingSequence: type: integer description: "The boarding sequence number.\n " compartmentDesignator: type: string description: "The passenger seat compartment designator.\n " maxLength: 2 minLength: 0 nullable: true unitDesignator: type: string description: "The passenger seat compartment designator.\n " maxLength: 2 minLength: 0 nullable: true status: description: "The leg's status.\n " $ref: '#/components/schemas/LegStatus' liftStatus: description: "The lift status.\n " $ref: '#/components/schemas/LiftStatus' departureTimeUtc: type: string description: "The departure time using the time variant in universal time.\n\ \ " format: date-time nullable: true arrivalTimeUtc: type: string description: "The arrival time using the time variant in universal time.\n\ \ " format: date-time nullable: true IJsonResponseOfUser: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/User' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' User: type: object description: "Defines a unique user.\n " additionalProperties: false required: - roles - username - codes properties: lastAlertReadDate: type: string description: "The date the alerts were last read.\n " format: date-time nullable: true lastNewsReadDate: type: string description: "The date the news was last read.\n " format: date-time nullable: true allowed: type: boolean description: "Flag indicating if status is allowed.\n " lastLogon: type: string description: "The data and time of last login.\n " format: date-time nullable: true passwordLastChanged: type: string description: "The date and time the password was last changed.\n \ \ " format: date-time nullable: true roles: type: array description: "The collection of authorized roles.\n " items: $ref: '#/components/schemas/UserRole' settings: type: array description: "The collection of agent settings.\n " nullable: true items: $ref: '#/components/schemas/UserSetting' status: description: "The status of the account.\n " nullable: true $ref: '#/components/schemas/UserStatus' username: type: string description: "The unique username.\n " maxLength: 64 minLength: 0 codes: description: "The identifying agent codes.\n " $ref: '#/components/schemas/UserCodes' hireDate: type: string description: "The date the agent was hired.\n " format: date-time nullable: true terminationDate: type: string description: "The date the agent was terminated.\n " format: date-time nullable: true note: type: string description: "The agent's note.\n " nullable: true traceQueueCode: type: string description: "The trace logging queue code.\n " nullable: true locked: type: boolean description: "Flag indicating if the account is locked.\n " forcePasswordReset: type: boolean description: "Flag indicating if the password needs to be reset.\n \ \ " nullable: true userKey: type: string description: "The unique user key.\n " nullable: true personKey: type: string description: "The unique person key associated to the user.\n \ \ " nullable: true UserRole: type: object description: "Defines a user role.\n " additionalProperties: false required: - roleCode - effectiveAfter properties: roleName: type: string description: "The role's name.\n " nullable: true parentRoleCode: type: string description: "The parents role code.\n " nullable: true roleCode: type: string description: "The unique role code.\n " minLength: 1 effectiveDays: type: array description: "The days the role is effective.\n " nullable: true items: $ref: '#/components/schemas/DayOfWeek' effectiveAfter: type: string description: "The date the role is effective after.\n " format: date-time minLength: 1 effectiveBefore: type: string description: "The date the role is effective before.\n " format: date-time nullable: true userRoleKey: type: string description: "The user role key.\n " nullable: true UserSetting: type: object description: "Defines the agent setting configuration.\n " additionalProperties: false properties: agentSettingTypeCode: type: string description: "The setting type code.\n " maxLength: 20 minLength: 0 nullable: true name: type: string description: "The setting type name.\n " maxLength: 64 minLength: 0 nullable: true inActive: type: boolean description: "The in active.\n " schema: type: string description: "The data schema.\n " maxLength: 2147483647 minLength: 0 nullable: true data: type: string description: "The setting data.\n " nullable: true version: type: integer description: "The settings version.\n " UserStatus: type: integer description: "Defines the status of a user.\n \n\n0 = Default\n1\ \ = Active\n2 = Pending\n3 = Suspended\n4 = Terminated" x-enumNames: - Default - Active - Pending - Suspended - Terminated enum: - 0 - 1 - 2 - 3 - 4 UserCodes: type: object description: "Defines all the different user codes.\n " additionalProperties: false required: - departmentCode - locationCode - organizationCode - domainCode properties: departmentCode: type: string description: "The user's department code.\n " maxLength: 4 minLength: 1 locationCode: type: string description: "The user's location code.\n " maxLength: 5 minLength: 1 locationGroupCode: type: string description: "The user's location group code.\n " nullable: true organizationCode: type: string description: "The user's organization code.\n " maxLength: 10 minLength: 0 organizationGroupCode: type: string description: "The user's organization group code.\n " nullable: true domainCode: type: string description: "The user's domain code.\n " maxLength: 3 minLength: 0 UserRequest: type: object description: "Defines the user request.\n " additionalProperties: false required: - username - codes properties: status: description: "The status of the account.\n " nullable: true $ref: '#/components/schemas/UserStatus' username: type: string description: "The unique username.\n " maxLength: 64 minLength: 0 codes: description: "The identifying agent codes.\n " $ref: '#/components/schemas/UserCodes' hireDate: type: string description: "The date the agent was hired.\n " format: date-time nullable: true terminationDate: type: string description: "The date the agent was terminated.\n " format: date-time nullable: true note: type: string description: "The agent's note.\n " nullable: true traceQueueCode: type: string description: "The trace logging queue code.\n " nullable: true locked: type: boolean description: "Flag indicating if the account is locked.\n " forcePasswordReset: type: boolean description: "Flag indicating if the password needs to be reset.\n \ \ " nullable: true DeltaMapperOfUserRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: status: description: "The status of the account.\n " nullable: true $ref: '#/components/schemas/UserStatus' username: type: string description: "The unique username.\n " maxLength: 64 minLength: 0 codes: description: "The identifying agent codes.\n " nullable: true properties: departmentCode: type: string description: "The user's department code.\n " maxLength: 4 minLength: 1 locationCode: type: string description: "The user's location code.\n " maxLength: 5 minLength: 1 locationGroupCode: type: string description: "The user's location group code.\n " nullable: true organizationCode: type: string description: "The user's organization code.\n " maxLength: 10 minLength: 0 organizationGroupCode: type: string description: "The user's organization group code.\n " nullable: true domainCode: type: string description: "The user's domain code.\n " maxLength: 3 minLength: 0 hireDate: type: string description: "The date the agent was hired.\n " format: date-time nullable: true terminationDate: type: string description: "The date the agent was terminated.\n " format: date-time nullable: true note: type: string description: "The agent's note.\n " nullable: true traceQueueCode: type: string description: "The trace logging queue code.\n " nullable: true locked: type: boolean description: "Flag indicating if the account is locked.\n " forcePasswordReset: type: boolean description: "Flag indicating if the password needs to be reset.\n \ \ " nullable: true UserCreateRequest: type: object description: "Defines the user create request.\n " additionalProperties: false required: - password - roles - username - codes - person properties: password: type: string description: "The unique password.\n " maxLength: 256 minLength: 0 roles: type: array description: "The collection of user roles.\n " items: $ref: '#/components/schemas/UserRoleCreateRequest' settings: type: array description: "The collection of agent settings.\n " nullable: true items: $ref: '#/components/schemas/UserSetting' sendRegistrationConfirmation: type: boolean description: "Send registration confirmation.\n " status: description: "The status of the account.\n " nullable: true $ref: '#/components/schemas/UserStatus' username: type: string description: "The unique username.\n " maxLength: 64 minLength: 0 codes: description: "The identifying agent codes.\n " $ref: '#/components/schemas/UserCodes' hireDate: type: string description: "The date the agent was hired.\n " format: date-time nullable: true terminationDate: type: string description: "The date the agent was terminated.\n " format: date-time nullable: true note: type: string description: "The agent's note.\n " nullable: true traceQueueCode: type: string description: "The trace logging queue code.\n " nullable: true locked: type: boolean description: "Flag indicating if the account is locked.\n " forcePasswordReset: type: boolean description: "Flag indicating if the password needs to be reset.\n \ \ " nullable: true person: description: "The person to create for the user.\n " $ref: '#/components/schemas/PersonCreateRequest' UserRoleCreateRequest: type: object description: "Defines the user role create request.\n " additionalProperties: false required: - effectiveAfter - roleCode properties: effectiveDays: type: array description: "The days the role is effective.\n " nullable: true items: $ref: '#/components/schemas/DayOfWeek' effectiveAfter: type: string description: "The date the role is effective after.\n " format: date-time minLength: 1 effectiveBefore: type: string description: "The date the role is effective before.\n " format: date-time nullable: true roleCode: type: string description: "The unique role code.\n " minLength: 1 PersonCreateRequest: type: object description: "Defines the person create request.\n " additionalProperties: false required: - name properties: customerNumber: type: string description: "The unique person customer number.\n " maxLength: 20 minLength: 0 nullable: true type: description: "The type of person.\n " nullable: true $ref: '#/components/schemas/PersonType' status: description: "The status of the person.\n " $ref: '#/components/schemas/PersonStatus' details: description: "The person's basic information.\n " nullable: true $ref: '#/components/schemas/PersonBasicInformation' notificationPreference: description: "The person's notification preference.\n " $ref: '#/components/schemas/NotificationPreference' name: description: "The persons true name.\n " $ref: '#/components/schemas/Name' emailAddresses: type: array description: "The collection of registered email address.\n " nullable: true items: $ref: '#/components/schemas/EmailCreateRequest' phoneNumbers: type: array description: "The collection of registered phone numbers.\n " nullable: true items: $ref: '#/components/schemas/PersonPhoneNumberRequest' addresses: type: array description: "The collection of known addresses.\n " nullable: true items: $ref: '#/components/schemas/PersonAddressCreateRequest' storedPayments: type: array description: "The collection of registered stored payments.\n \ \ " nullable: true items: $ref: '#/components/schemas/PersonStoredPaymentRequest' travelDocuments: type: array description: "The collection of registered travel documents.\n \ \ " nullable: true items: $ref: '#/components/schemas/PersonTravelDocumentRequest' programs: type: array description: "The collection of enrolled customer programs.\n \ \ " nullable: true items: $ref: '#/components/schemas/PersonCustomerProgramCreateRequest' comments: type: array description: "The collection of comments.\n " nullable: true items: $ref: '#/components/schemas/PersonCommentRequest' preferences: type: array description: "The collection of preferences.\n " nullable: true items: $ref: '#/components/schemas/PersonPreferenceCreateRequest' aliases: type: array description: "The collection of alternate names for the person.\n \ \ " nullable: true items: $ref: '#/components/schemas/PersonAliasRequest' affiliates: type: array description: "The collection of affiliates for the person.\n " nullable: true items: $ref: '#/components/schemas/PersonAffiliation' PersonType: type: integer description: "Defines the type of person.\n \n\n0 = None\n1 = Customer\n\ 2 = Agent" x-enumNames: - None - Customer - Agent enum: - 0 - 1 - 2 PersonStatus: type: integer description: "The status of the person.\n \n\n0 = Active\n1 = Terminated\n\ 2 = Suspended" x-enumNames: - Active - Terminated - Suspended enum: - 0 - 1 - 2 PersonBasicInformation: type: object description: "Defines the person's basic information.\n " additionalProperties: false properties: gender: description: "The person's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true nationality: type: string description: "The person's nationality.\n " nullable: true residentCountry: type: string description: "The person's resident country.\n " nullable: true passengerType: type: string description: "The type of passenger the person is.\n " nullable: true preferredCultureCode: type: string description: "The person's preferred culture code.\n " nullable: true preferredCurrencyCode: type: string description: "The person's preferred currency code.\n " nullable: true nationalIdNumber: type: string description: "The person's national ID number.\n " nullable: true declaredGender: type: string description: "The person's declared gender. A value of \"F\" is mapped to\ \ a female binary gender. All other values will be\nmapped to a male binary\ \ gender.\n " maxLength: 2 minLength: 0 nullable: true PersonPhoneNumberRequest: type: object description: "Defines the the person phone number.\n " additionalProperties: false required: - type - number properties: type: description: "The phone number type.\n " $ref: '#/components/schemas/PhoneNumberType' number: type: string description: "The phone number without any formatting characters.\n \ \ " maxLength: 20 minLength: 0 default: type: boolean description: "Flag indicating if this phone number is the default.\n \ \ " PersonAddressCreateRequest: type: object description: "Defines a person address request.\n " additionalProperties: false required: - addressTypeCode properties: default: type: boolean description: "Flag indicating if the address is the persons default.\n \ \ " lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true addressTypeCode: type: string description: "The type of address.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 minLength: 1 PersonStoredPaymentRequest: type: object description: "Defines the person's stored payment create request.\n \ \ " additionalProperties: false required: - paymentMethodType - paymentMethodCode - accountNumber properties: paymentMethodType: description: "The type of payment being added.\n " $ref: '#/components/schemas/PaymentMethodType' accountName: type: string description: "The name of the account.\n " maxLength: 64 minLength: 0 nullable: true expiration: type: string description: "The expiration.\n " format: date-time nullable: true paymentMethodCode: type: string description: "The payment method code.\n " maxLength: 2 minLength: 1 default: type: boolean description: "Indicates if the stored payment is the default.\n \ \ " accountNumber: type: string description: "The account number.\n " maxLength: 34 minLength: 0 PersonTravelDocumentRequest: type: object description: "Defines the person travel document.\n " additionalProperties: false required: - documentTypeCode properties: documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: string description: "The issuer code for the travel document (country code).\n\ \ " maxLength: 3 minLength: 0 nullable: true birthCountry: type: string description: "The BirthCountry property.\n " nullable: true name: description: "The Name property.\n " nullable: true $ref: '#/components/schemas/Name' nationality: type: string description: "The Nationality property.\n " maxLength: 2 minLength: 0 nullable: true expirationDate: type: string description: "The date when this travel document expires.\n " format: date-time nullable: true number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 nullable: true issuedDate: type: string description: "The date this travel document was issued.\n " format: date-time nullable: true gender: description: "The travel document holder's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true declaredGender: type: string description: "The travel document holder's declared gender.\nThis will override\ \ the gender field on passenger or person POST, PUT, and PATCH requests.\n\ Note: Any value other than \"F\" will cause gender to be updated to Male\ \ by default to support compatibility with\nother systems.\nAdditionally\ \ you cannot change the declared gender and gender fields at the same\ \ time as declared gender\nwill override any gender field value regardless\ \ of the value passed in.\n " maxLength: 2 minLength: 0 nullable: true placeOfBirth: type: string description: "Represents the place of birth. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, numbers,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true placeOfIssue: type: string description: "Represents the place of issue. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true default: type: boolean description: "Flag indicating if the travel document is the default.\n \ \ " PersonCustomerProgramCreateRequest: type: object description: "Defines a person's customer program create request.\n \ \ " additionalProperties: false required: - programNumber - programCode properties: programNumber: type: string description: "The unique program number for the person.\n " maxLength: 32 minLength: 0 effectiveDate: type: string description: "The effective date.\n " format: date-time nullable: true expirationDate: type: string description: "The expiration date.\n " format: date-time nullable: true default: type: boolean description: "True if this is set as the default program.\n " programLevelCode: type: string description: "The program level.\n " maxLength: 3 minLength: 0 nullable: true programCode: type: string description: "The program code.\n " maxLength: 3 minLength: 0 PersonCommentRequest: type: object description: "Defines a person comment request.\n " additionalProperties: false properties: text: type: string description: "The comments text.\n " nullable: true type: description: "The comment type.\n " $ref: '#/components/schemas/PersonCommentType' PersonCommentType: type: integer description: "Defines the different types of person comments.\n \n\ \n0 = Default\n1 = Itinerary\n2 = Manifest\n3 = Alert\n4 = Archive\n5 = Voucher" x-enumNames: - Default - Itinerary - Manifest - Alert - Archive - Voucher enum: - 0 - 1 - 2 - 3 - 4 - 5 PersonPreferenceCreateRequest: type: object description: "Defines a person preference create request.\n " additionalProperties: false properties: value: type: string description: "The value of the preference.\n " nullable: true code: type: string description: "The preference code.\n " nullable: true PersonAliasRequest: type: object description: "Defines the person alias request.\n " additionalProperties: false properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true type: description: "The type of alias.\n " $ref: '#/components/schemas/PersonAliasType' PersonAliasType: type: integer description: "Defines the type of alternate name.\n \n\n0 = Alias\n\ 1 = Variant" x-enumNames: - Alias - Variant enum: - 0 - 1 PersonAffiliation: type: object description: "Defines the person affiliation.\n " additionalProperties: false required: - name properties: name: type: string description: "The name of the affiliated person.\n " minLength: 1 personAffiliationKey: type: string description: "The unique person affiliation key.\n " nullable: true UserChangePasswordRequestBase: type: object description: "Defines a change password request base.\n " additionalProperties: false required: - newPassword properties: newPassword: type: string description: "The new password.\n " maxLength: 256 minLength: 0 IJsonResponseOfIListOfPersonAddress: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonAddress' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonAddress: type: object description: "Defines a unique person address.\n " additionalProperties: false required: - addressTypeCode properties: addressTypeCode: type: string description: "The type of address.\nPlease note that this should be a char\ \ and not a string.\n " maxLength: 1 minLength: 1 default: type: boolean description: "Flag indicating if the address is the persons default.\n \ \ " lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true personAddressKey: type: string description: "The unique person address key.\n " nullable: true IJsonResponseOfPersonAddress: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonAddress' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonAddressEditRequest: type: object description: "Defines the person address edit request.\n " additionalProperties: false properties: lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true default: type: boolean description: "Flag indicating if the address is the persons default.\n \ \ " DeltaMapperOfPersonAddressEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true default: type: boolean description: "Flag indicating if the address is the persons default.\n \ \ " IJsonResponseOfIListOfPersonAffiliation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonAffiliation' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonAffiliation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonAffiliation' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonAffiliationRequest: type: object description: "Defines the person affiliation.\n " additionalProperties: false required: - name properties: name: type: string description: "The name of the affiliated person.\n " minLength: 1 IJsonResponseOfIListOfPersonAlias: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonAlias' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonAlias: type: object description: "Defines a person's alternate name that they go by.\n \ \ " additionalProperties: false properties: type: description: "The type of alias.\n " $ref: '#/components/schemas/PersonAliasType' first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true personAliasKey: type: string description: "The unique person alias key.\n " nullable: true IJsonResponseOfPersonAlias: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonAlias' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' DeltaMapperOfPersonAliasRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true type: description: "The type of alias.\n " $ref: '#/components/schemas/PersonAliasType' IJsonResponseOfIListOfPersonComment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonComment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonComment: type: object description: "Defines a person comment.\n " additionalProperties: false properties: text: type: string description: "The comments text.\n " nullable: true type: description: "The comment type.\n " $ref: '#/components/schemas/PersonCommentType' personCommentKey: type: string description: "The unique person comment key.\n " nullable: true createdUserKey: type: string description: "The unique user key of the agent that created the comment.\n\ \ " nullable: true createdDate: type: string description: "The date the comment was created.\n " format: date-time modifiedUserKey: type: string description: "The unique user key of the agent that last modified the comment.\n\ \ " nullable: true modifiedDate: type: string description: "The date the comment was last modified.\n " format: date-time IJsonResponseOfPersonComment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonComment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' DeltaMapperOfPersonCommentRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: text: type: string description: "The comments text.\n " nullable: true type: description: "The comment type.\n " $ref: '#/components/schemas/PersonCommentType' IJsonResponseOfPerson: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Person' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Person: type: object description: "Defines a person.\n " additionalProperties: false required: - name properties: name: description: "The persons true name.\n " $ref: '#/components/schemas/PersonName' emailAddresses: type: array description: "The collection of registered email address.\n " nullable: true items: $ref: '#/components/schemas/PersonEmail' phoneNumbers: type: array description: "The collection of registered phone numbers.\n " nullable: true items: $ref: '#/components/schemas/PersonPhoneNumber' addresses: type: array description: "The collection of known addresses.\n " nullable: true items: $ref: '#/components/schemas/PersonAddress' storedPayments: type: array description: "The collection of registered stored payments.\n \ \ " nullable: true items: $ref: '#/components/schemas/PersonStoredPayment' travelDocuments: type: array description: "The collection of registered travel documents.\n \ \ " nullable: true items: $ref: '#/components/schemas/PersonTravelDocument' programs: type: array description: "The collection of enrolled customer programs.\n \ \ " nullable: true items: $ref: '#/components/schemas/PersonCustomerProgram' comments: type: array description: "The collection of comments.\n " nullable: true items: $ref: '#/components/schemas/PersonComment' preferences: type: array description: "The collection of preferences.\n " nullable: true items: $ref: '#/components/schemas/PersonPreference' aliases: type: array description: "The collection of alternate names for the person.\n \ \ " nullable: true items: $ref: '#/components/schemas/PersonAlias' affiliates: type: array description: "The collection of affiliations for the person.\n \ \ " nullable: true items: $ref: '#/components/schemas/PersonAffiliation' customerNumber: type: string description: "The unique person customer number.\n " maxLength: 20 minLength: 0 nullable: true type: description: "The type of person.\n " nullable: true $ref: '#/components/schemas/PersonType' status: description: "The status of the person.\n " $ref: '#/components/schemas/PersonStatus' details: description: "The person's basic information.\n " nullable: true $ref: '#/components/schemas/PersonBasicInformation' notificationPreference: description: "The person's notification preference.\n " $ref: '#/components/schemas/NotificationPreference' personKey: type: string description: "The unique person key.\n " nullable: true createdDate: type: string description: "The date the record was created.\n " format: date-time PersonName: type: object description: "Defines a person name.\n " additionalProperties: false properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true personNameKey: type: string description: "The unique person name key.\n " nullable: true PersonEmail: type: object description: "Defines a specific person email.\n " additionalProperties: false required: - type - email properties: type: type: string description: "The type code of the email address.\nPlease note that this\ \ should be a char and not a string.\n " maxLength: 1 minLength: 1 email: type: string description: "The email address value.\n " maxLength: 266 minLength: 0 default: type: boolean description: "Flag indicating if the email is the default.\n " personEmailKey: type: string description: "The unique email key.\n " nullable: true PersonPhoneNumber: type: object description: "Defines a unique person phone number.\n " additionalProperties: false required: - type - number properties: default: type: boolean description: "Flag indicating if this phone number is the default.\n \ \ " type: description: "The phone number type.\n " $ref: '#/components/schemas/PhoneNumberType' number: type: string description: "The phone number without any formatting characters.\n \ \ " maxLength: 20 minLength: 0 personPhoneNumberKey: type: string description: "The unique key for the phone number.\n " nullable: true PersonStoredPayment: type: object description: "Defines a specific person's stored payment.\n " additionalProperties: false required: - accountNumber - paymentMethodType - paymentMethodCode properties: accountNumber: type: string description: "The account number.\n " maxLength: 34 minLength: 0 paymentMethodType: description: "The type of payment being added.\n " $ref: '#/components/schemas/PaymentMethodType' accountName: type: string description: "The name of the account.\n " maxLength: 64 minLength: 0 nullable: true expiration: type: string description: "The expiration.\n " format: date-time nullable: true paymentMethodCode: type: string description: "The payment method code.\n " maxLength: 2 minLength: 1 default: type: boolean description: "Indicates if the stored payment is the default.\n \ \ " storedPaymentKey: type: string description: "The unique stored payment key.\n " nullable: true PersonTravelDocument: type: object description: "Defines a specific person travel document.\n " additionalProperties: false required: - documentTypeCode properties: default: type: boolean description: "Flag indicating if the travel document is the default.\n \ \ " documentTypeCode: type: string description: "The unique travel document type code.\n " maxLength: 4 minLength: 0 issuedByCode: type: string description: "The issuer code for the travel document (country code).\n\ \ " maxLength: 3 minLength: 0 nullable: true birthCountry: type: string description: "The BirthCountry property.\n " nullable: true name: description: "The Name property.\n " nullable: true $ref: '#/components/schemas/Name' nationality: type: string description: "The Nationality property.\n " maxLength: 2 minLength: 0 nullable: true expirationDate: type: string description: "The date when this travel document expires.\n " format: date-time nullable: true number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 nullable: true issuedDate: type: string description: "The date this travel document was issued.\n " format: date-time nullable: true gender: description: "The travel document holder's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true declaredGender: type: string description: "The travel document holder's declared gender.\nThis will override\ \ the gender field on passenger or person POST, PUT, and PATCH requests.\n\ Note: Any value other than \"F\" will cause gender to be updated to Male\ \ by default to support compatibility with\nother systems.\nAdditionally\ \ you cannot change the declared gender and gender fields at the same\ \ time as declared gender\nwill override any gender field value regardless\ \ of the value passed in.\n " maxLength: 2 minLength: 0 nullable: true placeOfBirth: type: string description: "Represents the place of birth. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, numbers,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true placeOfIssue: type: string description: "Represents the place of issue. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true personTravelDocumentKey: type: string description: "The unique person travel document key.\n " nullable: true PersonCustomerProgram: type: object description: "Defines a person's customer program.\n " additionalProperties: false required: - programCode - programNumber properties: pointBalance: type: integer description: "The current point balance.\n " format: int32 currentYearQualifyingPoints: type: integer description: "The current years qualifying points.\n " format: int32 currentYearRedeemablePoints: type: integer description: "The current years redeemable points.\n " format: int32 lifetimeAccumulatedQualifyingPoints: type: integer description: "The lifetime accumulated qualifying points.\n " format: int32 lifetimeAccumulatedRedeemablePoints: type: integer description: "The lifetime accumulated redeemable points.\n " format: int32 qualifyingPoints: type: integer description: "The qualifying points.\n " format: int32 qualifyingSegments: type: integer description: "The qualifying segments.\n " createdDate: type: string description: "The created date.\n " format: date-time nullable: true modifiedDate: type: string description: "The modified date.\n " format: date-time nullable: true programCode: type: string description: "The program code.\n " maxLength: 3 minLength: 0 programNumber: type: string description: "The unique program number for the person.\n " maxLength: 32 minLength: 0 effectiveDate: type: string description: "The effective date.\n " format: date-time nullable: true expirationDate: type: string description: "The expiration date.\n " format: date-time nullable: true default: type: boolean description: "True if this is set as the default program.\n " programLevelCode: type: string description: "The program level.\n " maxLength: 3 minLength: 0 nullable: true personCustomerProgramKey: type: string description: "The unique person customer program key.\n " nullable: true PersonPreference: type: object description: "Defines the person preferences.\n " additionalProperties: false properties: code: type: string description: "The preference code.\n " nullable: true value: type: string description: "The value of the preference.\n " nullable: true personPreferenceKey: type: string description: "The unique preference key.\n " nullable: true PersonEditRequest: type: object description: "Defines the person create request.\n " additionalProperties: false required: - name properties: type: description: "The type of person.\n " nullable: true $ref: '#/components/schemas/PersonType' status: description: "The status of the person.\n " $ref: '#/components/schemas/PersonStatus' details: description: "The person's basic information.\n " nullable: true $ref: '#/components/schemas/PersonBasicInformation' notificationPreference: description: "The person's notification preference.\n " $ref: '#/components/schemas/NotificationPreference' name: description: "The persons true name.\n " $ref: '#/components/schemas/Name' DeltaMapperOfPersonEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: type: description: "The type of person.\n " nullable: true $ref: '#/components/schemas/PersonType' status: description: "The status of the person.\n " $ref: '#/components/schemas/PersonStatus' details: description: "The person's basic information.\n " nullable: true properties: gender: description: "The person's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true nationality: type: string description: "The person's nationality.\n " nullable: true residentCountry: type: string description: "The person's resident country.\n " nullable: true passengerType: type: string description: "The type of passenger the person is.\n " nullable: true preferredCultureCode: type: string description: "The person's preferred culture code.\n " nullable: true preferredCurrencyCode: type: string description: "The person's preferred currency code.\n " nullable: true nationalIdNumber: type: string description: "The person's national ID number.\n " nullable: true declaredGender: type: string description: "The person's declared gender. A value of \"F\" is mapped\ \ to a female binary gender. All other values will be\nmapped to a\ \ male binary gender.\n " maxLength: 2 minLength: 0 nullable: true notificationPreference: description: "The person's notification preference.\n " $ref: '#/components/schemas/NotificationPreference' name: description: "The persons true name.\n " nullable: true properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true IJsonResponseOfIListOfPersonCustomerProgram: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonCustomerProgram' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonCustomerProgram: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonCustomerProgram' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonCustomerProgramEditRequest: type: object description: "Defines a person's customer program edit request.\n \ \ " additionalProperties: false required: - programNumber properties: programNumber: type: string description: "The unique program number for the person.\n " maxLength: 32 minLength: 0 effectiveDate: type: string description: "The effective date.\n " format: date-time nullable: true expirationDate: type: string description: "The expiration date.\n " format: date-time nullable: true default: type: boolean description: "True if this is set as the default program.\n " programLevelCode: type: string description: "The program level.\n " maxLength: 3 minLength: 0 nullable: true DeltaMapperOfPersonCustomerProgramEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: programNumber: type: string description: "The unique program number for the person.\n " maxLength: 32 minLength: 0 effectiveDate: type: string description: "The effective date.\n " format: date-time nullable: true expirationDate: type: string description: "The expiration date.\n " format: date-time nullable: true default: type: boolean description: "True if this is set as the default program.\n " programLevelCode: type: string description: "The program level.\n " maxLength: 3 minLength: 0 nullable: true IJsonResponseOfIListOfPersonEmail: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonEmail' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonEmail: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonEmail' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' EmailEditRequest: type: object description: "Defines the person email edit address.\n " additionalProperties: false required: - email properties: email: type: string description: "The email address value.\n " maxLength: 266 minLength: 0 default: type: boolean description: "Flag indicating if the email is the default.\n " DeltaMapperOfEmailEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: email: type: string description: "The email address value.\n " maxLength: 266 minLength: 0 default: type: boolean description: "Flag indicating if the email is the default.\n " IJsonResponseOfIListOfPersonInformation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonInformation' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonInformation: type: object description: "Defines the a person information.\n " additionalProperties: false required: - personInformationTypeCode properties: size: type: integer description: "The size of the information data.\n " format: int32 personInformationTypeCode: type: string description: "The person information type code.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 minLength: 1 data: type: string description: "The information data.\n " nullable: true personInformationKey: type: string description: "The unique person information key.\n " nullable: true IJsonResponseOfPersonInformation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonInformation' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonInformationCreateRequest: type: object description: "Defines a person information create request.\n " additionalProperties: false required: - personInformationTypeCode properties: data: type: string description: "The information data.\n " nullable: true personInformationTypeCode: type: string description: "The person information type code.\nPlease note that this should\ \ be a char and not a string.\n " maxLength: 1 minLength: 1 PersonInformationEditRequest: type: object description: "Defines a person information edit request.\n " additionalProperties: false properties: data: type: string description: "The information data.\n " nullable: true DeltaMapperOfPersonInformationEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: data: type: string description: "The information data.\n " nullable: true IJsonResponseOfIListOfPersonPhoneNumber: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonPhoneNumber' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonPhoneNumber: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonPhoneNumber' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' DeltaMapperOfPersonPhoneNumberRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: type: description: "The phone number type.\n " $ref: '#/components/schemas/PhoneNumberType' number: type: string description: "The phone number without any formatting characters.\n \ \ " maxLength: 20 minLength: 0 default: type: boolean description: "Flag indicating if this phone number is the default.\n \ \ " IJsonResponseOfIListOfPersonPreference: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonPreference' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonPreference: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonPreference' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonPreferenceEditRequest: type: object description: "Defines the person preference edit request.\n " additionalProperties: false properties: value: type: string description: "The value of the preference.\n " nullable: true DeltaMapperOfPersonPreferenceEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: value: type: string description: "The value of the preference.\n " nullable: true IJsonResponseOfIListOfPersonStoredPayment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonStoredPayment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonStoredPayment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonStoredPayment' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonStoredPaymentUpdateRequest: type: object description: "Defines the person's stored payment create request.\n \ \ " additionalProperties: false required: - paymentMethodType - paymentMethodCode properties: paymentMethodType: description: "The type of payment being added.\n " $ref: '#/components/schemas/PaymentMethodType' accountName: type: string description: "The name of the account.\n " maxLength: 64 minLength: 0 nullable: true expiration: type: string description: "The expiration.\n " format: date-time nullable: true paymentMethodCode: type: string description: "The payment method code.\n " maxLength: 2 minLength: 1 default: type: boolean description: "Indicates if the stored payment is the default.\n \ \ " DeltaMapperOfPersonStoredPaymentUpdateRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: paymentMethodType: description: "The type of payment being added.\n " $ref: '#/components/schemas/PaymentMethodType' accountName: type: string description: "The name of the account.\n " maxLength: 64 minLength: 0 nullable: true expiration: type: string description: "The expiration.\n " format: date-time nullable: true paymentMethodCode: type: string description: "The payment method code.\n " maxLength: 2 minLength: 1 default: type: boolean description: "Indicates if the stored payment is the default.\n \ \ " IJsonResponseOfIListOfPersonTravelDocument: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonTravelDocument' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonTravelDocument: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonTravelDocument' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfSkySpeedSettingsUserPreferences: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SkySpeedSettingsUserPreferences' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SkySpeedSettingsUserPreferences: type: object description: "Defines the SkySpeed default settings for the currently logged\ \ in user.\n " additionalProperties: false properties: currencyCode: type: string description: "The default currency.\n " maxLength: 3 minLength: 0 nullable: true cultureCode: type: string description: "The default culture code.\n " maxLength: 17 minLength: 0 nullable: true countryCode: type: string description: "The default country.\n " maxLength: 2 minLength: 0 nullable: true nationality: type: string description: "The default nationality.\n " maxLength: 2 minLength: 0 nullable: true collectionCurrencyCode: type: string description: "The currency that is used for fees and SSRs other than the\ \ default currency.\n " maxLength: 3 minLength: 0 nullable: true collectionCurrencySetting: description: "Indicates to which the collection currency will be applied\ \ to.\n " $ref: '#/components/schemas/CollectionCurrencySetting' flightResultFareType: description: "Indicates whether to display flights with monetary, loyalty\ \ or both fares in the flight results.\n " $ref: '#/components/schemas/FlightResultFareType' CollectionCurrencySetting: type: integer description: "Defines to which the collection currency will be applied.\n \ \ \n\n0 = None\n1 = Payments\n2 = Fees\n3 = Both" x-enumNames: - None - Payments - Fees - Both enum: - 0 - 1 - 2 - 3 FlightResultFareType: type: integer description: "Defines which fares will be included in the flight results.\n\ \ \n\n0 = All\n1 = Monetary\n2 = Loyalty" x-enumNames: - All - Monetary - Loyalty enum: - 0 - 1 - 2 IJsonResponseOfIListOfUserRole: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/UserRole' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfUserRole: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/UserRole' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' UserRoleEditRequest: type: object description: "Defines the user role edit request.\n " additionalProperties: false required: - effectiveAfter properties: effectiveAfter: type: string description: "The date the role is effective after.\n " format: date-time minLength: 1 effectiveBefore: type: string description: "The date the role is effective before.\n " format: date-time nullable: true effectiveDays: type: array description: "The days the role is effective.\n " nullable: true items: $ref: '#/components/schemas/DayOfWeek' DeltaMapperOfUserRolePatchRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: effectiveAfter: type: string description: "The date the role is effective after.\n " format: date-time minLength: 1 effectiveBefore: type: string description: "The date the role is effective before.\n " format: date-time nullable: true UserRolePatchRequest: type: object description: "Defines the user role patch request.\n " additionalProperties: false required: - effectiveAfter properties: effectiveAfter: type: string description: "The date the role is effective after.\n " format: date-time minLength: 1 effectiveBefore: type: string description: "The date the role is effective before.\n " format: date-time nullable: true UserCreateRequestv2: type: object description: "Defines the v2 user create request.\n " additionalProperties: false required: - password - roles - username - codes - personKey properties: password: type: string description: "The unique password.\n " maxLength: 256 minLength: 0 roles: type: array description: "The collection of user roles.\n " items: $ref: '#/components/schemas/UserRoleCreateRequest' settings: type: array description: "The collection of agent settings.\n " nullable: true items: $ref: '#/components/schemas/UserSetting' sendRegistrationConfirmation: type: boolean description: "Send registration confirmation.\n " status: description: "The status of the account.\n " nullable: true $ref: '#/components/schemas/UserStatus' username: type: string description: "The unique username.\n " maxLength: 64 minLength: 0 codes: description: "The identifying agent codes.\n " $ref: '#/components/schemas/UserCodes' hireDate: type: string description: "The date the agent was hired.\n " format: date-time nullable: true terminationDate: type: string description: "The date the agent was terminated.\n " format: date-time nullable: true note: type: string description: "The agent's note.\n " nullable: true traceQueueCode: type: string description: "The trace logging queue code.\n " nullable: true locked: type: boolean description: "Flag indicating if the account is locked.\n " forcePasswordReset: type: boolean description: "Flag indicating if the password needs to be reset.\n \ \ " nullable: true personKey: type: string description: "The unique person key associated with the user.\n \ \ " minLength: 1 IJsonResponseOfIListOfUserRecord: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/UserRecord' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' UserRecord: type: object description: "Defines a user record.\n " additionalProperties: false properties: userKey: type: string description: "The unique user key.\n " nullable: true username: type: string description: "The unique username.\n " nullable: true name: description: "The user's name.\n " nullable: true $ref: '#/components/schemas/Name' roles: type: array description: "The collection of user roles.\n " nullable: true items: $ref: '#/components/schemas/UserRole' status: description: "The status of the user.\n " $ref: '#/components/schemas/UserStatus' allowed: type: boolean description: "Flag indicating if the user is allowed.\n " domainCode: type: string description: "The domain the user exists in.\n " nullable: true organizationCode: type: string description: "The organization the user exists in.\n " nullable: true TravelDocumentEditRequestv2: type: object description: "Defines the edit travel document request.\n " additionalProperties: false required: - number properties: birthCountry: type: string description: "The BirthCountry property.\n " nullable: true name: description: "The Name property.\n " nullable: true $ref: '#/components/schemas/Name' nationality: type: string description: "The Nationality property.\n " maxLength: 2 minLength: 0 nullable: true expirationDate: type: string description: "The date when this travel document expires.\n " format: date-time nullable: true number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: string description: "The date this travel document was issued.\n " format: date-time nullable: true default: type: boolean description: "Flag indicating if the travel document is the default.\n \ \ " gender: description: "The travel document holder's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true declaredGender: type: string description: "The travel document holder's declared gender.\nThis will override\ \ the gender field on passenger or person POST, PUT, and PATCH requests.\n\ Note: Any value other than \"F\" will cause gender to be updated to Male\ \ by default to support compatibility with\nother systems.\nAdditionally\ \ you cannot change the declared gender and gender fields at the same\ \ time as declared gender\nwill override any gender field value regardless\ \ of the value passed in.\n " maxLength: 2 minLength: 0 nullable: true placeOfBirth: type: string description: "Represents the place of birth. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true placeOfIssue: type: string description: "Represents the place of issue. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true DeltaMapperOfTravelDocumentEditRequestv2: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: birthCountry: type: string description: "The BirthCountry property.\n " nullable: true name: description: "The Name property.\n " nullable: true properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true nationality: type: string description: "The Nationality property.\n " maxLength: 2 minLength: 0 nullable: true expirationDate: type: string description: "The date when this travel document expires.\n " format: date-time nullable: true number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: string description: "The date this travel document was issued.\n " format: date-time nullable: true default: type: boolean description: "Flag indicating if the travel document is the default.\n \ \ " gender: description: "The travel document holder's gender.\n " nullable: true $ref: '#/components/schemas/Gender' dateOfBirth: type: string description: "The person's date of birth.\n " format: date-time nullable: true declaredGender: type: string description: "The travel document holder's declared gender.\nThis will override\ \ the gender field on passenger or person POST, PUT, and PATCH requests.\n\ Note: Any value other than \"F\" will cause gender to be updated to Male\ \ by default to support compatibility with\nother systems.\nAdditionally\ \ you cannot change the declared gender and gender fields at the same\ \ time as declared gender\nwill override any gender field value regardless\ \ of the value passed in.\n " maxLength: 2 minLength: 0 nullable: true placeOfBirth: type: string description: "Represents the place of birth. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true placeOfIssue: type: string description: "Represents the place of issue. Only used on the following\ \ document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId\ \ (21).\nOnly allows alpha characters, please do not use spaces, hyphens,\ \ or special characters.\nNote: If unsure which travel document types\ \ fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\n\ or `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n \ \ " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ nullable: true SingleSignOnCredentials: type: object description: "Defines the single sign on credentials.\n " additionalProperties: false required: - singleSignOn - providerKey properties: singleSignOn: type: string description: "The single sign on token.\n " minLength: 1 providerKey: type: string description: "The unique single sign on provider key.\n " minLength: 1 providerName: type: string description: "The single sign on provider name.\n " nullable: true applicationName: type: string description: "The optional name of the calling application\n " nullable: true channelType: description: "The optional channel type invoking the communication with\ \ the server.\n " nullable: true $ref: '#/components/schemas/ChannelType' domain: type: string description: "The domain code of the calling application\n " nullable: true SingleSignOnCreateRequest: type: object description: "Defines the single sign on create request.\n " additionalProperties: false required: - singleSignOnCredentials - person properties: codes: description: "The identifying agent codes.\n " nullable: true $ref: '#/components/schemas/UserCodes' singleSignOnCredentials: description: "The single sign on credentials.\n " $ref: '#/components/schemas/SingleSignOnCredentials' person: description: "The person information to be used.\n " $ref: '#/components/schemas/PersonCreateRequest' IJsonResponseOfIListOfSingleSignOnProvider: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/SingleSignOnProvider' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SingleSignOnProvider: type: object description: "Defines the single sign on credentials.\n " additionalProperties: false properties: name: type: string description: "The single sign on provider name.\n " maxLength: 64 minLength: 0 nullable: true authorizationEndpoint: type: string description: "The single sign on provider authorization endpoint.\n \ \ " maxLength: 256 minLength: 0 nullable: true tokenEndpoint: type: string description: "The single sign on provider token endpoint.\n " maxLength: 256 minLength: 0 nullable: true clientIdentifier: type: string description: "The single sign on provider client identifier.\n \ \ " maxLength: 256 minLength: 0 nullable: true singleSignOnType: type: string description: "The single sign on type.\n " nullable: true inActive: type: boolean description: "Indicates if the single sign on provider is active.\n \ \ " providerKey: type: string description: "A unique identifier for the single sign on provider.\n \ \ " nullable: true IJsonResponseOfSingleSignOnProvider: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/SingleSignOnProvider' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfUserSingleSignOnToken: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/UserSingleSignOnToken' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' UserSingleSignOnToken: type: object description: "Defines a user's single sign on token.\n " additionalProperties: false required: - singleSignOn properties: providerKey: type: string description: "The unique single sign on provider key.\n " nullable: true singleSignOn: type: string description: "The single sign on token.\n " maxLength: 256 minLength: 0 expirationDate: type: string description: "The single sign on token expiration date.\n " format: date-time nullable: true IJsonResponseOfUserSingleSignOnToken: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/UserSingleSignOnToken' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' SingleSignOnTokenRequest: type: object description: "Defines the single sign on token request.\n " additionalProperties: false required: - singleSignOn properties: singleSignOn: type: string description: "The single sign on token.\n " maxLength: 256 minLength: 0 expirationDate: type: string description: "The single sign on token expiration date.\n " format: date-time nullable: true DeltaMapperOfSingleSignOnTokenRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: singleSignOn: type: string description: "The single sign on token.\n " maxLength: 256 minLength: 0 expirationDate: type: string description: "The single sign on token expiration date.\n " format: date-time nullable: true UserCustomerCreateRequest: type: object description: "Defines the user customer create request that will be setup with\ \ the defined default customer creation parameters.\n " additionalProperties: false required: - username - password - person properties: username: type: string description: "The unique username.\n " maxLength: 64 minLength: 0 password: type: string description: "The unique password.\n " minLength: 1 sendRegistrationConfirmation: type: boolean description: "Send registration configrmation.\n " person: description: "The person record to be associated with the customer.\n \ \ " $ref: '#/components/schemas/PersonCreateRequest' IJsonResponseOfNskRoles: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/NskRoles' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' UserImpersonateRequest: type: object description: "Defines a user impersonate request.\n " additionalProperties: false required: - roleCode properties: roleCode: type: string description: "The role to impersonate.\n " minLength: 1 UserChangePasswordRequestv2: type: object description: "Defines a user change password request.\n " additionalProperties: false required: - newPassword - currentPassword properties: newPassword: type: string description: "The new password.\n " maxLength: 256 minLength: 0 currentPassword: type: string description: "The current user's password.\n " maxLength: 256 minLength: 0 IJsonResponseOfIListOfPersonTravelNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/PersonTravelNotification' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonTravelNotification: type: object description: "A person travel notification.\n " additionalProperties: false properties: travelNotificationKey: type: string description: "The travel notification key.\n " nullable: true events: type: array description: "The list of travel notification event.\n " nullable: true items: $ref: '#/components/schemas/NotificationEvent' timedEvents: type: array description: "The list of travel notification event.\n " nullable: true items: $ref: '#/components/schemas/NotificationTimedEvent' cultureCode: type: string description: "The culture code.\n " nullable: true notificationDestination: description: "The notification destination.\n " nullable: true $ref: '#/components/schemas/NotificationDestination' deviceName: type: string description: "The name of the device for the push notification.\n \ \ " nullable: true createdDate: type: string description: "The created date of the travel notification.\n " format: date-time nullable: true IJsonResponseOfPersonTravelNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonTravelNotification' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfPagedBookingSearchByPersonResult: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PagedBookingSearchByPersonResult' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PagedBookingSearchByPersonResult: type: object description: "Defines a paged booking search by person result.\n " additionalProperties: false properties: bookings: type: array description: "The booking search results.\n " nullable: true items: $ref: '#/components/schemas/BookingSearchByPersonResult' lastPageKey: type: string description: "The last page key of the last paged item.\nThis value can\ \ be used in another request to page the data correctly and identifies\ \ the last result in this request.\n " nullable: true BookingSearchByPersonResult: type: object description: "Defines the search booking by person result.\n " additionalProperties: false properties: bookingDate: type: string description: "Returns the latest date that the booking was created.\n \ \ " format: date-time nullable: true departureDate: type: string description: "The departure date is associated with the returned leg of\ \ the booking.\n " format: date-time nullable: true arrivalStation: type: string description: "The arrival station code. For all configured stations see\ \ GET /api/nsk/v1/resources/Stations\n " maxLength: 3 minLength: 3 nullable: true departureStation: type: string description: "The departure station code. For all configured stations see\ \ GET /api/nsk/v1/resources/Stations\n " maxLength: 3 minLength: 3 nullable: true recordLocator: type: string description: "The record locator which uniquely identifies the booking.\n\ \ " nullable: true bookingKey: type: string description: "The booking key is another unique identifier similar to the\ \ record locator. Due to technical reasons some endpoints will require\ \ it vs the record locator.\n " nullable: true PersonMergeRequestBase: type: object description: "The base request to merge two persons with their program/s.\n\ \ " additionalProperties: false required: - deletePersonKey properties: deletePersonKey: type: string description: "The person that would be removed from the merge.\n \ \ " minLength: 1 newName: description: "The new name of the merged person.\n " nullable: true $ref: '#/components/schemas/Name' customerProgramCodes: type: array description: "The list of customer program codes to be merged.\n \ \ " nullable: true items: type: string IJsonResponseOfPersonRecordsResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PersonRecordsResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PersonRecordsResponse: type: object description: "Defines the person record response.\n " additionalProperties: false properties: records: type: array description: "The person records search results.\n " nullable: true items: $ref: '#/components/schemas/PersonRecord' lastIndex: type: integer description: "The last index of the paged response.\n " format: int64 PersonRecord: type: object description: "Defines the person record.\n " additionalProperties: false properties: personKey: type: string description: "The unique person key.\n " nullable: true type: description: "The person's type.\n " $ref: '#/components/schemas/PersonType' status: description: "The person's status.\n " $ref: '#/components/schemas/PersonStatus' customerNumber: type: string description: "The person's customer number.\n " nullable: true name: description: "The person's name.\n " nullable: true $ref: '#/components/schemas/Name' phoneNumber: type: string description: "The person's default phone number.\n " nullable: true emailAddress: type: string description: "The person's default email address.\n " nullable: true address: description: "The person's default address.\n " nullable: true $ref: '#/components/schemas/Address' programLoyaltyNumber: type: string description: "The person's default program loyalty number.\n " nullable: true IJsonResponseOfRetrieveAllotmentClassResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/RetrieveAllotmentClassResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' RetrieveAllotmentClassResponse: type: object description: "The retrieve allotment class response model\n " additionalProperties: false properties: lastPageKey: type: string description: "The LastPageKey, where to start paged query.\n " nullable: true allotmentClasses: type: array description: "The list of allotment bases.\n " nullable: true items: $ref: '#/components/schemas/AllotmentClassResponse' AllotmentClassResponse: type: object description: "The allotment class response base model\n " additionalProperties: false properties: allotmentClassCode: type: string description: "The allotment class code.\n " nullable: true contractCode: type: string description: "The contact code.\n " nullable: true description: type: string description: "The description.\n " nullable: true status: description: "The allotment class status.\n " $ref: '#/components/schemas/AllotmentClassStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' AllotmentClassStatus: type: integer description: "The allotment class status enumeration.\n \n\n0 = Default\n\ 1 = Active\n2 = Closed" x-enumNames: - Default - Active - Closed enum: - 0 - 1 - 2 AllotmentType: type: integer description: "Specifies the allotment type.\n \n\n0 = Fixed\n1 =\ \ Prorata" x-enumNames: - Fixed - Prorata enum: - 0 - 1 IJsonResponseOfAllotmentClassResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AllotmentClassResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AllotmentClassRequest: type: object description: "The allotment class request model\n " additionalProperties: false required: - allotmentClassCode - status - allotmentType properties: allotmentClassCode: type: string description: "The allotment class code.\n " minLength: 1 description: type: string description: "The description.\n " nullable: true status: description: "The allotment class status.\n " $ref: '#/components/schemas/AllotmentClassStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' AllotmentClassUpdateRequest: type: object description: "The allotment class request model\n " additionalProperties: false properties: description: type: string description: "The description.\n " nullable: true status: description: "The allotment class status.\n " $ref: '#/components/schemas/AllotmentClassStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' IJsonResponseOfIListOfAllotment2ContractResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Allotment2ContractResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Allotment2ContractResponse: type: object description: "The allotment contract response model for fares manager plus.\n\ \ " additionalProperties: false properties: contractCode: type: string description: "The Contract Code\n " nullable: true description: type: string description: "The description\n " nullable: true status: description: "The contract status\n " $ref: '#/components/schemas/AllotmentContractStatus' organizationCode: type: string description: "The organization code\n " nullable: true discontinueDate: type: string description: "The discontinue date\n " format: date-time nullable: true AllotmentContractStatus: type: integer description: "The allotment contract status enumeration.\n \n\n0\ \ = Default\n1 = Active\n2 = Closed" x-enumNames: - Default - Active - Closed enum: - 0 - 1 - 2 IJsonResponseOfAllotment2ContractResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Allotment2ContractResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Allotment2ContractRequest: type: object description: "The allotment 2 contract request model\n " additionalProperties: false required: - contractCode - status properties: contractCode: type: string description: "The Contract Code.\n " minLength: 1 description: type: string description: "The description\n " nullable: true status: description: "The contract status\n " $ref: '#/components/schemas/AllotmentContractStatus' discontinueDate: type: string description: "The discontinue date\n " format: date-time nullable: true Allotment2ContractUpdateRequest: type: object description: "The allotment 2 contract update request model.\n " additionalProperties: false required: - status properties: description: type: string description: "The description\n " nullable: true status: description: "The contract status\n " $ref: '#/components/schemas/AllotmentContractStatus' discontinueDate: type: string description: "The discontinue date\n " format: date-time nullable: true IJsonResponseOfRetrieveAllotmentBasisResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/RetrieveAllotmentBasisResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' RetrieveAllotmentBasisResponse: type: object description: "The retrieve allotment basis response model\n " additionalProperties: false properties: lastPageKey: type: string description: "The LastPageKey, where to start paged query.\n " nullable: true allotmentBasisResponses: type: array description: "The list of allotment bases.\n " nullable: true items: $ref: '#/components/schemas/AllotmentBasisResponseBase' AllotmentBasisResponseBase: type: object description: "The allotment basis response base model\n " additionalProperties: false properties: allotmentBasisCode: type: string description: "The allotment basis code.\n " nullable: true contractCode: type: string description: "The contract code.\n " nullable: true description: type: string description: "The description.\n " nullable: true status: description: "The allotment basis status.\n " $ref: '#/components/schemas/AllotmentBasisStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' classNest: type: integer description: "The class nest.\n " classRank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The Latest Advance Reservation.\n " ruleTariff: type: string description: "The rule tariff.\n " nullable: true carrierCode: type: string description: "The carrier code.\n " nullable: true ruleNumber: type: string description: "The rule number.\n " nullable: true fareBasisCode: type: string description: "The fare basis code.\n " nullable: true AllotmentBasisStatus: type: integer description: "The allotment basis status enumeration.\n \n\n0 = Default\n\ 1 = Active\n2 = Closed" x-enumNames: - Default - Active - Closed enum: - 0 - 1 - 2 IJsonResponseOfAllotmentBasisResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AllotmentBasisResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AllotmentBasisResponse: type: object description: "The allotment basis response model\n " additionalProperties: false properties: allotmentBasisCode: type: string description: "The allotment basis code.\n " nullable: true contractCode: type: string description: "The contract code.\n " nullable: true description: type: string description: "The description.\n " nullable: true status: description: "The allotment basis status.\n " $ref: '#/components/schemas/AllotmentBasisStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' classNest: type: integer description: "The class nest.\n " classRank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The Latest Advance Reservation.\n " ruleTariff: type: string description: "The rule tariff.\n " nullable: true carrierCode: type: string description: "The carrier code.\n " nullable: true ruleNumber: type: string description: "The rule number.\n " nullable: true fareBasisCode: type: string description: "The fare basis code.\n " nullable: true allotmentMarketFares: type: array description: "The allotment market fares associated with the allotment basis.\n\ \ " nullable: true items: $ref: '#/components/schemas/AllotmentMarketFareResponse' AllotmentMarketFareResponse: type: object description: "The allotment market fare response model\n " additionalProperties: false properties: allotmentMarketFareKey: type: string description: "The allotment market fare key.\n " nullable: true allotmentBasisCode: type: string description: "The allotment basis code.\n " nullable: true stationCode: type: string description: "The station code.\n " nullable: true travelStationCode: type: string description: "The travel station code.\n " nullable: true fareSequence: type: integer description: "The fare sequence.\n " directionality: description: "The directionality.\n " $ref: '#/components/schemas/Directionality' price: type: number description: "The price.\n " format: decimal currencyCode: type: string description: "The currency code.\n " nullable: true releaseDate: type: string description: "The release date.\n " format: date-time discontinueDate: type: string description: "The discontinue date.\n " format: date-time AllotmentBasisRequest: type: object description: "The allotment basis request model\n " additionalProperties: false required: - allotmentBasisCode - status - allotmentType properties: allotmentBasisCode: type: string description: "The allotment basis code.\n " minLength: 1 description: type: string description: "The description.\n " nullable: true status: description: "The allotment basis status.\n " $ref: '#/components/schemas/AllotmentBasisStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' classNest: type: integer description: "The class nest.\n " classRank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The Latest Advance Reservation.\n " ruleTariff: type: string description: "The rule tariff.\n " nullable: true carrierCode: type: string description: "The carrier code.\n " nullable: true ruleNumber: type: string description: "The rule number.\n " nullable: true fareBasisCode: type: string description: "The fare basis code.\n " nullable: true AllotmentBasisUpdateRequest: type: object description: "The allotment basis update request model\n " additionalProperties: false properties: description: type: string description: "The description.\n " nullable: true status: description: "The allotment basis status.\n " $ref: '#/components/schemas/AllotmentBasisStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' classNest: type: integer description: "The class nest.\n " classRank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The Latest Advance Reservation.\n " ruleTariff: type: string description: "The rule tariff.\n " nullable: true carrierCode: type: string description: "The carrier code.\n " nullable: true ruleNumber: type: string description: "The rule number.\n " nullable: true fareBasisCode: type: string description: "The fare basis code.\n " nullable: true IJsonResponseOfIListOfAllotmentContractResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/AllotmentContractResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AllotmentContractResponse: type: object description: "The allotment contract response model\n " additionalProperties: false properties: contractCode: type: string description: "The Contract Code\n " nullable: true description: type: string description: "The description\n " nullable: true status: description: "The contract status\n " $ref: '#/components/schemas/AllotmentContractStatus' organizationCode: type: string description: "The organization code\n " nullable: true discontinueDate: type: string description: "The discontinue date\n " format: date-time nullable: true contractProperties: type: array description: "The contract properties\n " nullable: true items: $ref: '#/components/schemas/AllotmentContractProperty' AllotmentContractProperty: type: object description: "The allotment contract property.\n " additionalProperties: false properties: contractPropertyCode: type: string description: "The contract property code.\n " nullable: true value: type: string description: "The allotment value.\n " nullable: true IJsonResponseOfAllotmentContractResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AllotmentContractResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AllotmentContractRequest: type: object description: "The allotment contract request model\n " additionalProperties: false required: - contractCode - status properties: contractCode: type: string description: "The Contract Code.\n " minLength: 1 description: type: string description: "The description\n " nullable: true status: description: "The contract status\n " $ref: '#/components/schemas/AllotmentContractStatus' discontinueDate: type: string description: "The discontinue date\n " format: date-time nullable: true contractProperties: type: array description: "The contract properties\n " nullable: true items: $ref: '#/components/schemas/AllotmentContractProperty' AllotmentContractUpdateRequest: type: object description: "The allotment contract update request model\n " additionalProperties: false properties: description: type: string description: "The description\n " nullable: true status: description: "The contract status\n " $ref: '#/components/schemas/AllotmentContractStatus' discontinueDate: type: string description: "The discontinue date\n " format: date-time nullable: true IJsonResponseOfIListOfAllotmentResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/AllotmentResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AllotmentResponse: type: object description: "The allotment response model.\n " additionalProperties: false properties: allotmentBasisCode: type: string description: "The allotment basis code.\n " nullable: true authorizedUnits: type: integer description: "The number of class authorized units.\n " allotted: type: integer description: "The number of classes allotted.\n " nest: type: integer description: "The class nest.\n " classOfService: type: string description: "The class of service.\n " nullable: true type: description: "The class of service type.\n " $ref: '#/components/schemas/ClassOfServiceType' rank: type: integer description: "The class rank.\n " seatsSold: type: integer description: "The number of class seats sold.\n " latestAdvanceReservation: type: integer description: "The latest advance reservation.\n " status: description: "The class status.\n " $ref: '#/components/schemas/ClassStatus' legNestKey: type: string description: "The leg nest key. Useful for inventory operations.\n \ \ " nullable: true legClassKey: type: string description: "The leg class key. Useful for inventory operations.\n \ \ " nullable: true legKey: type: string description: "The leg key.\n " nullable: true marketInformation: description: "The market information of the allotment.\n " nullable: true $ref: '#/components/schemas/MarketInformation' IJsonResponseOfAllotmentResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AllotmentResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfAllotmentCreatedResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AllotmentCreatedResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AllotmentCreatedResponse: type: object description: "Model representing a created allotment.\n " additionalProperties: false properties: allotmentBasisCode: type: string description: "The allotment basis code.\n " nullable: true legKey: type: string description: "The leg key.\n " nullable: true legNestKey: type: string description: "The leg nest key. Useful for inventory operations.\n \ \ " nullable: true legClassKey: type: string description: "The leg class key. Useful for inventory operations.\n \ \ " nullable: true AllotmentRequest: type: object description: "The allotment request model.\n " additionalProperties: false properties: authorizedUnits: type: integer description: "The number of class authorized units.\n " allotted: type: integer description: "The number of classes allotted.\n " nest: type: integer description: "The class nest.\n " classType: description: "The allotment class type.\n " $ref: '#/components/schemas/AllotmentClassType' rank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The latest advance reservation.\n " status: description: "The class status.\n " $ref: '#/components/schemas/ClassStatus' AllotmentClassType: type: integer description: "The class of service type enumeration.\n \n\n4 = NegoAllotment\n\ 5 = ProrataAllotment" x-enumNames: - NegoAllotment - ProrataAllotment enum: - 4 - 5 CreateAllotmentFareRequest: type: object description: "The create allotment fare request model\n " additionalProperties: false required: - fareBatchID - ruleNumber - location1 - location2 properties: fareBatchID: type: integer description: "The fare batch ID.\n " format: int32 fareTariffCode: type: string description: "The tariff code.\n " nullable: true carrierCode: type: string description: "The carrier code.\n " nullable: true ruleNumber: type: string description: "The rule number.\n " minLength: 1 location1: type: string description: "The first location code. This must be either a city code or\ \ station code. These should be placed in alphabetical\norder. If they\ \ are not then directionality will be switched and the locations will\ \ be returned in alphabetical\norder on retrieval.\n " minLength: 1 location2: type: string description: "The second location code. This must be either a city code\ \ or station code. These should be placed in alphabetical\norder. If they\ \ are not then directionality will be switched and the locations will\ \ be returned in alphabetical\norder on retrieval.\n " minLength: 1 fareApplicationRequest: description: "The fare application request.\n " nullable: true $ref: '#/components/schemas/FareApplicationRequest' FareApplicationRequest: type: object description: "The fare application request model\n " additionalProperties: false required: - currencyCode - effectiveDate - oneWayRoundTrip - price properties: currencyCode: type: string description: "The currency code.\n " minLength: 1 effectiveDate: type: string description: "The effective date.\n " format: date-time minLength: 1 discontinueDate: type: string description: "The discontinue date.\n " format: date-time nullable: true fareDirection: description: "The fare direction.\n " $ref: '#/components/schemas/FareDirection' inBoundOutBound: description: "The inbound/outbound specification.\n " $ref: '#/components/schemas/InBoundOutBound' oneWayRoundTrip: description: "The one way/round trip specification.\n " $ref: '#/components/schemas/OneWayRoundTrip' openJaw: type: boolean description: "The boolean indicating if the trip is open jaw.\n \ \ " pointPrice: type: integer description: "The point price.\n " format: int32 price: type: number description: "The price.\n " format: decimal routeNumber: type: integer description: "The Route Number.\n " sortPrice: type: number description: "The sort price.\n " format: decimal nullable: true sumOfSegmentCharge: type: number description: "The sum of segment charge.\n " format: decimal tripDirection: description: "The trip direction.\n " $ref: '#/components/schemas/TripDirection' UpdateAllotmentFareRequest: type: object description: "The update allotment fare request model\n " additionalProperties: false required: - previousFareBatchID - currentFareBatchID - fareApplicationRequest properties: previousFareBatchID: type: integer description: "The previous fare batch ID.\n " format: int32 currentFareBatchID: type: integer description: "The current fare batch ID.\n " format: int32 fareApplicationRequest: description: "The fare application request.\n " $ref: '#/components/schemas/FareApplicationRequest' IJsonResponseOfIListOfAllotmentMarketFareResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/AllotmentMarketFareResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfAllotmentMarketFareResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/AllotmentMarketFareResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' AllotmentMarketFareRequest: type: object description: "The allotment market fare update request model.\n " additionalProperties: false required: - stationCode - travelStationCode - price properties: stationCode: type: string description: "The station code.\nMust come alphabetically before the travel\ \ station code.\n " maxLength: 3 minLength: 0 travelStationCode: type: string description: "The travel station code.\n " maxLength: 3 minLength: 0 directionality: description: "The directionality of the fare.\nIf not provided this will\ \ default to both ways.\n " nullable: true $ref: '#/components/schemas/Directionality' price: type: number description: "The price.\n " format: decimal currencyCode: type: string description: "The currency code.\nIf not provided this will default to your\ \ configured default currency code.\n " maxLength: 3 minLength: 0 nullable: true releaseDate: type: string description: "The release date.\nIf not provided this will default to today.\n\ \ " format: date-time nullable: true discontinueDate: type: string description: "The discontinue date.\nIf not provided this will default to\ \ never discontinue.\n " format: date-time nullable: true IJsonResponseOfOrganizationCommissionRate: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/OrganizationCommissionRate' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' OrganizationCommissionRate: type: object description: "The commission rate details of an organization.\n " additionalProperties: false properties: commissionRateCode: type: string description: "Commission rate code.\n " maxLength: 8 minLength: 0 nullable: true directRate: type: number description: "The direct rate.\n " format: decimal gdsRate: type: number description: "The Gds rate.\n " format: decimal webRate: type: number description: "The web rate.\n " format: decimal apiRate: type: number description: "The Api rate.\n " format: decimal addOnRate: type: number description: "The add on rate.\n " format: decimal OrganizationCreateRequest: type: object description: "The data on the organization.\n " additionalProperties: false properties: organizationCode: type: string description: "The organization code.\n " maxLength: 10 minLength: 2 nullable: true type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' configuration: description: "Advanced configuration values.\n " nullable: true $ref: '#/components/schemas/OrganizationConfigurationv2' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: string description: "The parent organization code.\n " maxLength: 10 minLength: 2 nullable: true statementNote: type: string description: "The statement note.\n " maxLength: 128 minLength: 0 nullable: true lastStatementDate: type: string description: "The last statement date.\n " format: date-time nullable: true sendNotification: type: boolean description: "Send agency activation notification.\n " externalAccounts: type: array description: "External accounts.\n " nullable: true items: $ref: '#/components/schemas/OrganizationExternalAccountRequest' commissionRates: type: array description: "Commission rates.\n " nullable: true items: $ref: '#/components/schemas/OrganizationCommissionRate' company: description: "The company details.\n " nullable: true $ref: '#/components/schemas/CompanyDetails' contact: description: "The contact details.\n " nullable: true $ref: '#/components/schemas/ContactDetails' organizationProcessSchedules: type: array description: "Process Schedules.\n " nullable: true items: $ref: '#/components/schemas/OrganizationProcessSchedule' OrganizationType: type: integer description: "Organization type.\n \n\n0 = Default\n1 = Master\n\ 2 = Carrier\n3 = TravelAgency\n4 = ThirdParty" x-enumNames: - Default - Master - Carrier - TravelAgency - ThirdParty enum: - 0 - 1 - 2 - 3 - 4 OrganizationConfigurationv2: type: object description: "The configuration details of an organization.\n " additionalProperties: false properties: cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 1 nullable: true commissionable: type: boolean description: "Commissionable.\n " recalculateCommission: type: boolean description: "Recalculate commission.\n " recallCommission: type: boolean description: "Recall commission.\n " nettedTotal: type: boolean description: "Netted total.\n " gdsEmailItinerary: description: "Gds email itinerary.\n " $ref: '#/components/schemas/ExternalDistributionOption' sourceIsInternal: type: boolean description: "Organization source is internal. Otherwise its external.\n\ \ " sourceIsDeleted: type: boolean description: "Organization source is deleted. Otherwise its active.\n \ \ " traceQueueCode: type: string description: "The trace queue code.\n " maxLength: 6 minLength: 0 nullable: true referralType: description: "Referral type.\n " $ref: '#/components/schemas/ReferralType' ExternalDistributionOption: type: integer description: "Describes the external distribution option.\n \n\n\ 0 = NoDistribution\n1 = UseOrganizationEmailOnly\n2 = UseMessageEmailOnly\n\ 3 = UseMessageEmail" x-enumNames: - NoDistribution - UseOrganizationEmailOnly - UseMessageEmailOnly - UseMessageEmail enum: - 0 - 1 - 2 - 3 ReferralType: type: integer description: "Referral type.\n \n\n0 = Default\n1 = Allowed\n2 =\ \ AllowedWithUrlMatch\n3 = NotAllowed" x-enumNames: - Default - Allowed - AllowedWithUrlMatch - NotAllowed enum: - 0 - 1 - 2 - 3 OrganizationStatus: type: integer description: "Organization status.\n \n\n0 = Default\n1 = Active\n\ 2 = Cancelled\n3 = Pending" x-enumNames: - Default - Active - Cancelled - Pending enum: - 0 - 1 - 2 - 3 OrganizationExternalAccountRequest: type: object description: "The data for an organizations external account.\n " additionalProperties: false properties: name: type: string description: "The name of the external account.\n " maxLength: 256 minLength: 0 nullable: true description: type: string description: "The description.\n " maxLength: 128 minLength: 0 nullable: true routingNumber: type: string description: "The routing number.\n " maxLength: 32 minLength: 0 nullable: true accountNumber: type: string description: "The account number.\n " maxLength: 34 minLength: 0 nullable: true bankIdentifierCode: type: string description: "The band identifier code (BIC).\n " maxLength: 16 minLength: 0 nullable: true internationalBankAccountNumber: type: string description: "The international bank account number or IBAN.\n \ \ " maxLength: 64 minLength: 0 nullable: true notes: type: string description: "The notes.\n " maxLength: 128 minLength: 0 nullable: true CompanyDetails: type: object description: "The organization company details of an organization.\n \ \ " additionalProperties: false properties: name: type: string description: "The organization name.\n " nullable: true address: description: "The address of the organization.\n " nullable: true $ref: '#/components/schemas/Address' url: type: string description: "The website url of the organization.\n " maxLength: 2048 minLength: 0 nullable: true emailAddress: type: string description: "The email address.\n " format: email nullable: true internalNote: type: string description: "Internal note.\n " maxLength: 256 minLength: 0 nullable: true externalNote: type: string description: "External note.\n " maxLength: 256 minLength: 0 nullable: true phoneNumbers: type: array description: "The available phone numbers.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' ContactDetails: type: object description: "The contact details for an organization.\n " additionalProperties: false properties: name: description: "The contact name.\n " nullable: true $ref: '#/components/schemas/Name' phoneNumbers: type: array description: "The available contact phone numbers.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' OrganizationProcessSchedule: type: object description: "The OrganizationCode defines a link between an Organization and\ \ a ProcessSchedule.\n " additionalProperties: false properties: processScheduleID: type: integer description: "The ProcessScheduleID of the Process Schedule of an organization.\n\ \ " format: int64 OrganizationEditRequest: type: object description: "The base data on the organization.\n " additionalProperties: false properties: organizationCode: type: string description: "The organization code.\n " maxLength: 10 minLength: 2 nullable: true type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' configuration: description: "Advanced configuration values.\n " nullable: true $ref: '#/components/schemas/OrganizationConfigurationv2' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: string description: "The parent organization code.\n " maxLength: 10 minLength: 2 nullable: true statementNote: type: string description: "The statement note.\n " maxLength: 128 minLength: 0 nullable: true lastStatementDate: type: string description: "The last statement date.\n " format: date-time nullable: true company: description: "The company details.\n " nullable: true $ref: '#/components/schemas/CompanyEditDetails' contact: description: "The contact details.\n " nullable: true $ref: '#/components/schemas/ContactEditDetails' CompanyEditDetails: type: object description: "The organization company details of an organization.\n \ \ " additionalProperties: false required: - name properties: name: type: string description: "The organization name.\n " minLength: 1 address: description: "The address of the organization.\n " nullable: true $ref: '#/components/schemas/Address' url: type: string description: "The website url of the organization.\n " maxLength: 2048 minLength: 0 nullable: true emailAddress: type: string description: "The email address.\n " format: email nullable: true internalNote: type: string description: "Internal note.\n " maxLength: 256 minLength: 0 nullable: true externalNote: type: string description: "External note.\n " maxLength: 256 minLength: 0 nullable: true ContactEditDetails: type: object description: "The contact details for an organization.\n " additionalProperties: false properties: name: description: "The contact name.\n " nullable: true $ref: '#/components/schemas/Name' DeltaMapperOfOrganizationEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n \ \ " additionalProperties: false properties: organizationCode: type: string description: "The organization code.\n " maxLength: 10 minLength: 2 nullable: true type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' configuration: description: "Advanced configuration values.\n " nullable: true properties: cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 1 nullable: true commissionable: type: boolean description: "Commissionable.\n " recalculateCommission: type: boolean description: "Recalculate commission.\n " recallCommission: type: boolean description: "Recall commission.\n " nettedTotal: type: boolean description: "Netted total.\n " gdsEmailItinerary: description: "Gds email itinerary.\n " $ref: '#/components/schemas/ExternalDistributionOption' sourceIsInternal: type: boolean description: "Organization source is internal. Otherwise its external.\n\ \ " sourceIsDeleted: type: boolean description: "Organization source is deleted. Otherwise its active.\n\ \ " traceQueueCode: type: string description: "The trace queue code.\n " maxLength: 6 minLength: 0 nullable: true referralType: description: "Referral type.\n " $ref: '#/components/schemas/ReferralType' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: string description: "The parent organization code.\n " maxLength: 10 minLength: 2 nullable: true statementNote: type: string description: "The statement note.\n " maxLength: 128 minLength: 0 nullable: true lastStatementDate: type: string description: "The last statement date.\n " format: date-time nullable: true company: description: "The company details.\n " nullable: true properties: name: type: string description: "The organization name.\n " minLength: 1 address: description: "The address of the organization.\n " nullable: true properties: lineOne: type: string description: "The address line one.\n " maxLength: 128 minLength: 0 nullable: true lineTwo: type: string description: "The address line two.\n " maxLength: 128 minLength: 0 nullable: true lineThree: type: string description: "The address line 3.\n " maxLength: 128 minLength: 0 nullable: true countryCode: type: string description: "The country code.\n " maxLength: 2 minLength: 0 nullable: true provinceState: type: string description: "The province state.\n " maxLength: 3 minLength: 0 nullable: true city: type: string description: "The city.\n " maxLength: 32 minLength: 0 nullable: true postalCode: type: string description: "The postal code.\n " maxLength: 10 minLength: 0 nullable: true url: type: string description: "The website url of the organization.\n " maxLength: 2048 minLength: 0 nullable: true emailAddress: type: string description: "The email address.\n " format: email nullable: true internalNote: type: string description: "Internal note.\n " maxLength: 256 minLength: 0 nullable: true externalNote: type: string description: "External note.\n " maxLength: 256 minLength: 0 nullable: true contact: description: "The contact details.\n " nullable: true properties: name: description: "The contact name.\n " nullable: true properties: first: type: string description: "The given first name.\n " maxLength: 32 minLength: 0 nullable: true middle: type: string description: "The given middle name.\n " maxLength: 32 minLength: 0 nullable: true last: type: string description: "The given last name.\n " maxLength: 32 minLength: 0 nullable: true title: type: string description: "The title.\n " maxLength: 6 minLength: 0 nullable: true suffix: type: string description: "The suffix.\n " maxLength: 6 minLength: 0 nullable: true IJsonResponseOfOrganizationv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Organizationv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Organizationv2: type: object description: "The base data on the organization.\n " additionalProperties: false properties: organizationCode: type: string description: "The organization code.\n " maxLength: 10 minLength: 2 nullable: true type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' configuration: description: "Advanced configuration values.\n " nullable: true $ref: '#/components/schemas/OrganizationConfigurationv2' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: string description: "The parent organization code.\n " maxLength: 10 minLength: 2 nullable: true statementNote: type: string description: "The statement note.\n " maxLength: 128 minLength: 0 nullable: true lastStatementDate: type: string description: "The last statement date.\n " format: date-time nullable: true externalAccounts: type: array description: "External accounts.\n " nullable: true items: $ref: '#/components/schemas/OrganizationExternalAccountv2' commissionRates: type: array description: "Commission rates.\n " nullable: true items: $ref: '#/components/schemas/OrganizationCommissionRate' company: description: "The company details.\n " nullable: true $ref: '#/components/schemas/CompanyDetails' contact: description: "The contact details.\n " nullable: true $ref: '#/components/schemas/ContactDetails' organizationProcessSchedules: type: array description: "Process Schedules.\n " nullable: true items: $ref: '#/components/schemas/OrganizationProcessSchedule' OrganizationExternalAccountv2: type: object description: "The data for an organizations external account.\n " additionalProperties: false properties: name: type: string description: "The name of the external account.\n " maxLength: 256 minLength: 0 nullable: true description: type: string description: "The description.\n " maxLength: 128 minLength: 0 nullable: true routingNumber: type: string description: "The routing number.\n " maxLength: 32 minLength: 0 nullable: true accountNumber: type: string description: "The account number.\n " maxLength: 34 minLength: 0 nullable: true bankIdentifierCode: type: string description: "The band identifier code (BIC).\n " maxLength: 16 minLength: 0 nullable: true internationalBankAccountNumber: type: string description: "The international bank account number or IBAN.\n \ \ " maxLength: 64 minLength: 0 nullable: true notes: type: string description: "The notes.\n " maxLength: 128 minLength: 0 nullable: true externalAccountKey: type: string description: "The unique key for the external account.\n " nullable: true OrganizationRegisterRequest: type: object description: "The data on the organization register request.\n " additionalProperties: false required: - organizationCode properties: organizationCode: type: string description: "The organization code.\n " maxLength: 10 minLength: 2 company: description: "The company details.\n " nullable: true $ref: '#/components/schemas/CompanyDetails' contact: description: "The contact details.\n " nullable: true $ref: '#/components/schemas/ContactDetails' externalAccounts: type: array description: "External accounts.\n " nullable: true items: $ref: '#/components/schemas/OrganizationExternalAccountRequest' currencyCode: type: string description: "The organization's currency code.\n " nullable: true cultureCode: type: string description: "The organization's culture code.\n " nullable: true IJsonResponseOfOrganizationExternalAccountv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/OrganizationExternalAccountv2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfOrganizationGroup: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/OrganizationGroup' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' OrganizationGroup: type: object description: "The data for an organization group.\n " additionalProperties: false required: - organizationGroupCode properties: organizationGroupCode: type: string description: "The organization group code.\n " maxLength: 3 minLength: 1 name: type: string description: "The organization group name.\n " nullable: true IJsonResponseOfOrganizationGroupDetails: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/OrganizationGroupDetails' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' OrganizationGroupDetails: type: object description: "The data for an organization group including details.\n \ \ " additionalProperties: false required: - organizationGroupCode properties: organizationGroupCode: type: string description: "The organization group code.\n " maxLength: 3 minLength: 1 name: type: string description: "The organization group name.\n " nullable: true organizations: type: array description: "The organizations included in the group.\n " nullable: true items: $ref: '#/components/schemas/OrganizationRecordMinimum' OrganizationRecordMinimum: type: object description: "The data for a simple organization record.\n " additionalProperties: false required: - organizationCode properties: organizationCode: type: string description: "The organization group code.\n " maxLength: 10 minLength: 1 name: type: string description: "The organization company name.\n " nullable: true OrganizationGroupRequest: type: object description: "The data for an organization group request.\n " additionalProperties: false properties: organizationGroupName: type: string description: "The organization group name.\n " nullable: true organization: description: "The organization included in the group.\n " nullable: true $ref: '#/components/schemas/OrganizationRecordMinimum' IJsonResponseOfIListOfProcessSchedule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ProcessSchedule' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ProcessSchedule: type: object description: "The data for an organizations Process Schedule.\nProcess Schedule\ \ is a reporting tool that is used to generate agency commission statements.\n\ It\u2019s a batch process that runs daily to see when the reports should be\ \ generated and\ndetermine when a statement is generated and sent to an organization.\n\ \ " deprecated: true x-deprecatedMessage: 4.4.4 - Please use ProcessSchedulev2. additionalProperties: false properties: processScheduleId: type: integer description: "The ProcessScheduleID of ProcessSchedule.\n " format: int64 name: type: string description: "The Name of ProcessSchedule.\n " nullable: true beginDate: type: string description: "The BeginDate of ProcessSchedule.\n " format: date-time frequencyType: description: "The FrequencyType of ProcessSchedule.\n " $ref: '#/components/schemas/FrequencyType' daysOfWeek: description: "The DaysOfWeek of ProcessSchedule.\n " $ref: '#/components/schemas/DayOfWeek' frequency: type: integer description: "The Frequency of ProcessSchedule.\n " monthDay: type: integer description: "The MonthDay of ProcessSchedule.\n " monthWeek: description: "The MonthWeek of ProcessSchedule.\n " $ref: '#/components/schemas/MonthWeek' inActive: type: boolean description: "The InActive of ProcessSchedule.\n " FrequencyType: type: integer description: "FrequencyType Enumeration. Based on ones for SQL server scheduler,\ \ not all included.\n \n\n0 = Daily\n1 = Weekly\n2 = Monthly" x-enumNames: - Daily - Weekly - Monthly enum: - 0 - 1 - 2 MonthWeek: type: integer description: "MonthWeek Enumeration. Based on ones for SQL server scheduler,\ \ not all included.\n \n\n0 = None\n1 = First\n2 = Second\n3 =\ \ Third\n4 = Fourth\n5 = Last" x-enumNames: - None - First - Second - Third - Fourth - Last enum: - 0 - 1 - 2 - 3 - 4 - 5 IJsonResponseOfProcessSchedule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ProcessSchedule' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ProcessScheduleCreateRequest: type: object description: "The data for creating a new Process Schedule.\nProcess Schedule\ \ is a reporting tool that is used to generate agency commission statements.\n\ It\u2019s a batch process that runs daily to see when the reports should be\ \ generated and\ndetermine when a statement is generated and sent to an organization.\n\ \ " deprecated: true x-deprecatedMessage: 4.4.4 - Please use ProcessScheduleCreateRequestv2. additionalProperties: false properties: name: type: string description: "The Name of ProcessSchedule.\n " nullable: true beginDate: type: string description: "The BeginDate of ProcessSchedule.\n " format: date-time nullable: true frequencyType: description: "The FrequencyType of ProcessSchedule.\n " nullable: true $ref: '#/components/schemas/FrequencyType' daysOfWeek: description: "The DaysOfWeek of ProcessSchedule.\n " nullable: true $ref: '#/components/schemas/DayOfWeek' frequency: type: integer description: "The Frequency of ProcessSchedule.\n " nullable: true monthDay: type: integer description: "The MonthDay of ProcessSchedule.\n " nullable: true monthWeek: description: "The MonthWeek of ProcessSchedule.\n " nullable: true $ref: '#/components/schemas/MonthWeek' inActive: type: boolean description: "The InActive of ProcessSchedule.\n " nullable: true IJsonResponseOfIListOfOrganizationProcessSchedule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/OrganizationProcessSchedule' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfOrganizationRecord: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/OrganizationRecord' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' OrganizationRecord: type: object description: "The data on the user related agent's organization.\n \ \ " additionalProperties: false required: - organizationCode properties: organizationCode: type: string description: "The organization code.\n " maxLength: 10 minLength: 2 type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' company: description: "The company details.\n " nullable: true $ref: '#/components/schemas/CompanyDetailsRecord' contact: description: "The contact details.\n " nullable: true $ref: '#/components/schemas/ContactDetails' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: string description: "The parent organization code.\n " maxLength: 10 minLength: 2 nullable: true CompanyDetailsRecord: type: object description: "The organization company details record results.\n " additionalProperties: false required: - name properties: name: type: string description: "The organization name.\n " minLength: 1 address: description: "The address of the organization.\n " nullable: true $ref: '#/components/schemas/Address' url: type: string description: "The website url of the organization.\n " maxLength: 2048 minLength: 0 nullable: true emailAddress: type: string description: "The email address.\n " format: email nullable: true phoneNumbers: type: array description: "The available phone numbers.\n " nullable: true items: $ref: '#/components/schemas/PhoneNumber' OrganizationGroupCreateRequest: type: object description: "The organization group create request.\n " additionalProperties: false required: - organizationGroupCode properties: organizationGroupCode: type: string description: "The organization group code.\n " minLength: 1 organizationGroupName: type: string description: "The organization group name.\n " nullable: true organization: description: "The organization included in the group.\n " nullable: true $ref: '#/components/schemas/OrganizationRecordMinimum' IJsonResponseOfIListOfProcessSchedulev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/ProcessSchedulev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ProcessSchedulev2: type: object description: "The data for an organizations Process Schedule, v2.\nProcess Schedule\ \ is a reporting tool that is used to generate agency commission statements.\n\ It\u2019s a batch process that runs daily to see when the reports should be\ \ generated and\ndetermine when a statement is generated and sent to an organization.\n\ \ " additionalProperties: false properties: processScheduleId: type: integer description: "The ProcessScheduleID of ProcessSchedulev2.\n " format: int64 name: type: string description: "The Name of ProcessSchedule.\n " nullable: true beginDate: type: string description: "The BeginDate of ProcessSchedule.\n " format: date-time frequencyType: description: "The FrequencyType of ProcessSchedule.\n " $ref: '#/components/schemas/FrequencyType' daysOfWeek: type: array description: "The DaysOfWeek List of ProcessSchedule.\n " nullable: true items: $ref: '#/components/schemas/DayOfWeek' frequency: type: integer description: "The Frequency of ProcessSchedule.\n " monthDay: type: integer description: "The MonthDay of ProcessSchedule.\n " monthWeek: description: "The MonthWeek of ProcessSchedule.\n " $ref: '#/components/schemas/MonthWeek' inActive: type: boolean description: "The InActive of ProcessSchedule.\n " IJsonResponseOfProcessSchedulev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/ProcessSchedulev2' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' ProcessScheduleCreateRequestv2: type: object description: "The data for creating a new Process Schedule, v2.\nProcess Schedule\ \ is a reporting tool that is used to generate agency commission statements.\n\ It\u2019s a batch process that runs daily to see when the reports should be\ \ generated and\ndetermine when a statement is generated and sent to an organization.\n\ \ " additionalProperties: false properties: name: type: string description: "The Name of ProcessSchedule.\n " nullable: true beginDate: type: string description: "The BeginDate of ProcessSchedule.\n " format: date-time nullable: true frequencyType: description: "The FrequencyType of ProcessSchedule.\n " nullable: true $ref: '#/components/schemas/FrequencyType' daysOfWeek: type: array description: "The DaysOfWeek List of ProcessSchedule.\n " nullable: true items: $ref: '#/components/schemas/DayOfWeek' frequency: type: integer description: "The Frequency of ProcessSchedule.\n " nullable: true monthDay: type: integer description: "The MonthDay of ProcessSchedule.\n " nullable: true monthWeek: description: "The MonthWeek of ProcessSchedule.\n " nullable: true $ref: '#/components/schemas/MonthWeek' inActive: type: boolean description: "The InActive of ProcessSchedule.\n " nullable: true IJsonResponseOfIListOfTransaction: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: array description: "The payload data.\n " nullable: true items: $ref: '#/components/schemas/Transaction' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Transaction: type: object description: "The transaction model.\n " additionalProperties: false required: - amount - currencyCode properties: amount: type: number description: "The credit account transaction amount.\n " format: decimal currencyCode: type: string description: "The credit account transaction currency code.\n \ \ " maxLength: 3 minLength: 0 note: type: string description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 nullable: true accountTransactionCode: type: string description: "The system-generated code for the transaction.\n \ \ " nullable: true recordLocator: type: string description: "The record locator from the refunded booking payment. This\ \ property is redundant and the same information can be\nfound on the\ \ AccountReference property.\n " deprecated: true x-deprecatedMessage: 4.4.4 - Please use Account Reference instead. nullable: true accountReference: type: string description: "The account reference. This property may contain a record\ \ locator, account number, string value, or may be null\ndepending on\ \ the transaction type.\n " nullable: true transactionKey: type: string description: "The unique transaction key.\n " nullable: true createdDate: type: string description: "The created date associated with the transaction.\n \ \ " format: date-time nullable: true foreignAmount: type: number description: "The transaction foreign amount.\n " format: decimal foreignCurrencyCode: type: string description: "The transaction foreign currency code.\n " maxLength: 3 minLength: 0 nullable: true type: description: "The transaction type.\n " $ref: '#/components/schemas/TransactionType' paymentId: type: integer description: "The payment ID of the transaction. This will only be non zero\ \ on refunded booking payments. A zero signifies that\nno payment ID is\ \ found.\n " format: int64 accountCollectionKey: type: string description: "The account collection key associated with the transaction.\n\ \ " nullable: true TransactionType: type: integer description: "The dotREZ specific transaction types. This includes some system\ \ specific values that\nare not allowed during a transaction creation.\n \ \ \n\n0 = Default\n1 = Payment\n2 = Adjustment\n3 = Supplementary\n\ 4 = Transfer\n5 = Spoilage\n6 = StatementDateAndBalance\n7 = PayableCommission\n\ 8 = Commission\n9 = ChildCommissionTransfer\n10 = ParentCommissionTransfer" x-enumNames: - Default - Payment - Adjustment - Supplementary - Transfer - Spoilage - StatementDateAndBalance - PayableCommission - Commission - ChildCommissionTransfer - ParentCommissionTransfer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 AccountExpirationUpdateRequest: type: object description: "The account transaction code model.\n " additionalProperties: false required: - expirationDate properties: expirationDate: type: string description: "The expiration date.\n " format: date-time minLength: 1 reinstateAmount: type: number description: "The re-instate amount.\n " format: decimal AccountPasswordChallengeRequest: type: object description: "The request for generating the challenge code when the new reset\ \ password flow is enabled.\n " additionalProperties: false required: - domain - username properties: domain: type: string description: "The domain code. See GET /resources/Domains for valid codes.\n\ \ " maxLength: 3 minLength: 0 username: type: string description: "The unique username.\n " maxLength: 64 minLength: 0 phoneNumber: type: string description: "The phone number to send the challenge code to.\n \ \ " maxLength: 20 minLength: 0 nullable: true email: type: string description: "The email address to send the challenge code to.\n \ \ " format: email nullable: true AccountPasswordChallengeResetRequest: type: object description: "The request for the new reset password flow.\n " additionalProperties: false required: - domain - username - challengeCode - newPassword properties: domain: type: string description: "The domain code. See GET /resources/Domains for valid codes.\n\ \ " maxLength: 3 minLength: 0 username: type: string description: "The unique username.\n " maxLength: 64 minLength: 0 challengeCode: type: string description: "The challenge code received from another source like email\ \ or text.\n " maxLength: 8 minLength: 0 newPassword: type: string description: "The new password to change to.\n " maxLength: 256 minLength: 0 AccountPasswordChallengeVerifyRequest: type: object description: "The request to verify the challenge code for the new reset password\ \ flow.\n " additionalProperties: false required: - domain - username - challengeCode properties: domain: type: string description: "The domain code. See GET /resources/Domains for valid codes.\n\ \ " maxLength: 3 minLength: 0 username: type: string description: "The unique username.\n " maxLength: 64 minLength: 0 challengeCode: type: string description: "The challenge code received from another source like email\ \ or text.\n " maxLength: 8 minLength: 0 AccountForgotPasswordRequest: type: object description: "Defines the account forgot password request.\n " additionalProperties: false required: - domainCode properties: domainCode: type: string description: "The domain the user is located in.\n " maxLength: 3 minLength: 0 username: type: string description: "The unique username.\n " nullable: true alternateIdentifier: type: string description: "The alternate identifier.\n " nullable: true AccountCollectionRequest: type: object description: "The account collection request model.\n " additionalProperties: false required: - amount - currencyCode properties: amount: type: number description: "The credit account transaction amount.\n " format: decimal currencyCode: type: string description: "The credit account transaction currency code.\n \ \ " maxLength: 3 minLength: 0 note: type: string description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 nullable: true transactionCode: type: string description: "The transaction code.\n " maxLength: 6 minLength: 0 nullable: true expiration: type: string description: "The account collection expiration.\n " format: date-time nullable: true IJsonResponseOfAccount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/Account' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' Account: type: object description: "The account model.\n " additionalProperties: false properties: accountKey: type: string description: "The account key.\n " nullable: true totalAvailable: type: number description: "The summed total of all currently available credit amounts\ \ for the account.\n " format: decimal owner: description: "The account owner type.\n " $ref: '#/components/schemas/AccountOwnerType' type: description: "The account type.\n " $ref: '#/components/schemas/AccountType' status: description: "The account status.\n " $ref: '#/components/schemas/AccountStatus' totalAmount: type: number description: "The total amount.\n " format: decimal foreignAvailable: type: number description: "The foreign currency available.\n " format: decimal foreignCurrencyCode: type: string description: "The foreign currency code.\n " nullable: true accountNumber: type: string description: "The account number associated to the customer or organization.\n\ \ " nullable: true expiredCreditAmount: type: number description: "The amount of credit that was unused and already expired.\n\ \ " format: decimal expiredCreditCurrencyCode: type: string description: "The currency code of the expired credit amount.\n \ \ " nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true collections: type: array description: "The list of account collections.\n " nullable: true items: $ref: '#/components/schemas/AccountCollection' accountName: type: string description: "The account name associated to the customer.\n " nullable: true AccountOwnerType: type: integer description: "The account owner type enumeration.\n \n\n0 = Organization\n\ 1 = Personnal\n2 = Booking\n3 = Unknown" x-enumNames: - Organization - Personnal - Booking - Unknown enum: - 0 - 1 - 2 - 3 AccountType: type: integer description: "The account type enumeration.\n \n\n0 = Credit\n1 =\ \ Prepaid\n2 = Supplementary\n3 = Dependent\n4 = Unknown" x-enumNames: - Credit - Prepaid - Supplementary - Dependent - Unknown enum: - 0 - 1 - 2 - 3 - 4 AccountStatus: type: integer description: "The account status enumeration.\n \n\n0 = Open\n1 =\ \ Closed\n2 = AgencyInactive\n3 = Unknown" x-enumNames: - Open - Closed - AgencyInactive - Unknown enum: - 0 - 1 - 2 - 3 AccountCollection: type: object description: "The account collection model.\n " additionalProperties: false properties: accountCollectionKey: type: string description: "The unique account collection key.\n " nullable: true available: type: number description: "The available amount.\n " format: decimal amount: type: number description: "The total amount.\n " format: decimal createdDate: type: string description: "The creation date.\n " format: date-time nullable: true transactionCode: type: string description: "The transaction code.\n " nullable: true expiration: type: string description: "The expiration date.\n " format: date-time nullable: true spoiledAmount: type: number description: "The spoiled amount.\n " format: decimal CreateAccountRequest: type: object description: "The create account request model.\n " additionalProperties: false properties: currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true TransactionRequest: type: object description: "The create transaction request.\n " additionalProperties: false required: - amount - currencyCode properties: amount: type: number description: "The credit account transaction amount.\n " format: decimal currencyCode: type: string description: "The credit account transaction currency code.\n \ \ " maxLength: 3 minLength: 0 note: type: string description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 nullable: true ChildAccountTransactionsRequest: type: object description: "The organization account transaction request.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The amount to adjust on the account.\n " format: decimal IJsonResponseOfOrganizationAccount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/OrganizationAccount' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' OrganizationAccount: type: object description: "The organization account model.\n " additionalProperties: false properties: accountKey: type: string description: "The account key.\n " nullable: true totalAvailable: type: number description: "The summed total of all currently available credit amounts\ \ for the account.\n " format: decimal owner: description: "The account owner type.\n " $ref: '#/components/schemas/AccountOwnerType' type: description: "The account type.\n " $ref: '#/components/schemas/AccountType' status: description: "The account status.\n " $ref: '#/components/schemas/AccountStatus' totalAmount: type: number description: "The total amount.\n " format: decimal foreignAvailable: type: number description: "The foreign currency available.\n " format: decimal foreignCurrencyCode: type: string description: "The foreign currency code.\n " nullable: true accountNumber: type: string description: "The account number associated to the customer or organization.\n\ \ " nullable: true expiredCreditAmount: type: number description: "The amount of credit that was unused and already expired.\n\ \ " format: decimal expiredCreditCurrencyCode: type: string description: "The currency code of the expired credit amount.\n \ \ " nullable: true currencyCode: type: string description: "The currency code.\n " maxLength: 3 minLength: 0 nullable: true collection: description: "The organization account collection.\n " nullable: true $ref: '#/components/schemas/AccountCollectionBase' AccountCollectionBase: type: object description: "The account collection base model.\n " additionalProperties: false properties: accountCollectionKey: type: string description: "The unique account collection key.\n " nullable: true available: type: number description: "The available amount.\n " format: decimal amount: type: number description: "The total amount.\n " format: decimal createdDate: type: string description: "The creation date.\n " format: date-time nullable: true CreateOrganizationAccountRequest: type: object description: "The create organization account request model.\n " additionalProperties: false properties: currencyCode: type: string description: "The account currency code.\n " maxLength: 3 minLength: 0 nullable: true totalAmount: type: number description: "The total amount of the account.\n " format: decimal type: description: "The allowed account types for account creation.\n \ \ " $ref: '#/components/schemas/AllowedAccountTypes' note: type: string description: "The optional note to associate with the account creation.\n\ \ " nullable: true AllowedAccountTypes: type: integer description: "The allowed account type enumeration. These are a subset of the\ \ AccountTypes enumeartion\nand represent the currently supported account\ \ types for an account creation.\n \n\n0 = Credit\n1 = Prepaid\n\ 2 = Supplementary" x-enumNames: - Credit - Prepaid - Supplementary enum: - 0 - 1 - 2 OrganizationTransactionRequest: type: object description: "The organization account transaction request.\n " additionalProperties: false required: - amount - currencyCode properties: amount: type: number description: "The credit account transaction amount.\n " format: decimal currencyCode: type: string description: "The credit account transaction currency code.\n \ \ " maxLength: 3 minLength: 0 note: type: string description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 nullable: true type: description: "The transaction types for an organization account.\n \ \ " $ref: '#/components/schemas/AllowedTransactionTypes' AllowedTransactionTypes: type: integer description: "The dotREZ specific transaction types.\n \n\n0 = Default\n\ 1 = Payment\n2 = Adjustment\n3 = Supplementary" x-enumNames: - Default - Payment - Adjustment - Supplementary enum: - 0 - 1 - 2 - 3 AccountChangePasswordRequestv2: type: object description: "Defines a change password request.\n " additionalProperties: false required: - newPassword - credentials properties: newPassword: type: string description: "The new password.\n " maxLength: 256 minLength: 0 credentials: description: "The current credentials.\n " $ref: '#/components/schemas/CredentialsBase' OrganizationRefundRequestv2: type: object description: "Defines information needed for an organization account refund,\ \ v2.\n " additionalProperties: false required: - amount - organizationCode properties: parentPaymentKey: type: string description: "The payment identifier used if this refund is being reversed\ \ from an existing payment.\nThe refund is assumed to be made at the booking/account\ \ level if the value for this property is null or empty.\n " nullable: true amount: type: number description: "The amount to apply.\n " format: decimal paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true organizationCode: type: string description: "The organization code account number to credit to.\n \ \ " maxLength: 34 minLength: 0 comment: type: string description: "The organization refund comment.\n " nullable: true IJsonResponseOfPagedTransactionResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " nullable: true $ref: '#/components/schemas/PagedTransactionResponse' errors: type: array description: "The collection of errors being thrown.\n " nullable: true items: $ref: '#/components/schemas/ErrorResponse' messages: type: array description: "The collection of informational messages.\n " nullable: true items: $ref: '#/components/schemas/Message' PagedTransactionResponse: type: object description: "The paged transaction response.\n " additionalProperties: false properties: totalCount: type: integer description: "The total count of transactions.\n " format: int32 lastPageKey: type: string description: "The last page key.\n " nullable: true transactions: type: array description: "The collection of transactions.\n " nullable: true items: $ref: '#/components/schemas/Transaction' OrganizationRefundRequest: type: object description: "Defines information needed for an organization account refund.\n\ \ " deprecated: true x-deprecatedMessage: 4.4.5 - Please use OrganizationRefundRequestv2 additionalProperties: false required: - amount - organizationCode properties: parentPaymentKey: type: string description: "The payment identifier used if this refund is being reversed\ \ from an existing payment.\nThe refund is assumed to be made at the booking/account\ \ level if the value for this property is null or empty.\n " nullable: true amount: type: number description: "The amount to apply.\n " format: decimal paymentFields: type: object description: "Dynamic field information used for validation related to the\ \ specific payment type.\nSee the PaymentMethodsAvailable view model /\ \ PaymentMethodFieldList\n " nullable: true additionalProperties: type: string currencyCode: type: string description: "The currency code. This will default to the bookings currency\ \ code.\n " maxLength: 3 minLength: 0 nullable: true organizationCode: type: string description: "The organization code account number to credit to.\n \ \ " maxLength: 34 minLength: 0 accountTransactionCode: type: string description: "The account transaction code associated with the account.\n\ \ " nullable: true comment: type: string description: "The organization refund comment.\n " nullable: true ScanSearchRequest: type: object description: "The search by scan request object\n " additionalProperties: false properties: scan: description: "Scan data to search with.\n " nullable: true $ref: '#/components/schemas/LocationParseRequest' origin: type: string description: "Origin station of the booking.\n " maxLength: 3 minLength: 3 nullable: true departureDate: type: string description: "Departure date of the booking.\n " format: date-time nullable: true LocationParseRequest: type: object description: "Request for converting scan track data into a scan result\n \ \ " additionalProperties: false properties: track1: type: string description: "Track 1 of scan data\n " nullable: true track2: type: string description: "Track 2\n " nullable: true track3: type: string description: "Track 3\n " nullable: true location: type: string description: "Location of parser\n " nullable: true PreloadDeviceType: type: integer description: "Types of printer preload devices\n \n\n0 = ATB\n1 =\ \ BTP" x-enumNames: - ATB - BTP enum: - 0 - 1 BoardingPassPrintRequest: type: object description: "Request to generate a boarding pass datastream.\n " additionalProperties: false properties: passengerKeys: type: array description: "Gets or sets the filtered passenger keys.\n " nullable: true items: type: string segmentKeys: type: array description: "Gets or sets the filtered segment keys.\n " nullable: true items: type: string location: type: string description: "Gets or sets the location to print as\n " nullable: true BagTagPrintRequest: type: object description: "Request for converting bag tags into print streams\n \ \ " additionalProperties: false properties: bagTagKeys: type: array description: "BagTag Keys for conversion\n " nullable: true items: type: string overrideStatusRestrictions: type: boolean description: "Flag to override whether bags are converted based on bag status\n\ \ " deprecated: true x-deprecatedMessage: This flag is no longer in use location: type: string description: "Location of resource to generate bag tag print streams\n \ \ " nullable: true BagTagPrintRequestv2: type: object description: "Request for converting bag tags into print streams\n \ \ " additionalProperties: false required: - passengerKeys - segmentKeys properties: passengerKeys: type: array description: "BagTag Keys for conversion.\n " items: type: string segmentKeys: type: array description: "SegmentKeys to generate print streams for.\n " items: type: string location: type: string description: "Location of resource to generate bag tag print streams.\n\ \ " nullable: true CombinedScan: type: object description: "Class to hold all the different scan types to have strong typing\ \ on a scan result.\n " additionalProperties: false properties: boardingPassScan: description: "Boarding pass scan.\n " nullable: true $ref: '#/components/schemas/BoardingPassScan' creditCardScan: description: "Credit card scan.\n " nullable: true $ref: '#/components/schemas/CreditCardScan' documentScan: description: "Document scan.\n " nullable: true $ref: '#/components/schemas/DocumentScan' itineraryScan: description: "Itinerary scan.\n " nullable: true $ref: '#/components/schemas/ItineraryScan' membershipCardScan: description: "Membership card scan.\n " nullable: true $ref: '#/components/schemas/MembershipCardScan' recordLocatorScan: description: "Record locator scan.\n " nullable: true $ref: '#/components/schemas/RecordLocatorScan' BoardingPassScan: type: object description: "A boarding pass scan.\n " additionalProperties: false properties: scanType: type: string description: "Gets or sets the Scan Type of the Scan.\n " nullable: true flightDay: type: integer description: "Flight Day\n " format: int32 mobileBarcode: type: string description: "Mobile Barcode\n " nullable: true boardingPass: description: "Boarding Pass\n " nullable: true $ref: '#/components/schemas/BoardingPassScanResponse' BoardingPassScanResponse: type: object description: "Represents a boarding pass on a boarding pass scan\n \ \ " additionalProperties: false properties: boardingPassNumber: type: integer description: "Boarding pass number\n " title: type: string description: "Title\n " nullable: true suffix: type: string description: "Suffix\n " nullable: true firstName: type: string description: "First name\n " nullable: true middleName: type: string description: "Middle name\n " nullable: true lastName: type: string description: "Last name\n " nullable: true recordLocator: type: string description: "Gets and Sets the RecordLocator of the passenger - links the\ \ passenger to the booking.\n " nullable: true customerNumber: type: string description: "Gets or Sets the identifier for the customer, i.e. Frequent\ \ Flyer number.\n " nullable: true selecteeString: type: string description: "Gets or Sets the string that indicates a selectee.\n \ \ " nullable: true baseFare: type: number description: "Gets or Sets the base fare for this reservation.\n \ \ " format: decimal totalTax: type: number description: "Gets or Sets the Taxes for this reservation.\n " format: decimal totalCost: type: number description: "Gets or Sets the Total Cost for this reservation.\n \ \ " format: decimal totalFare: type: number description: "Gets or Sets the Total fare for this reservation.\n \ \ " format: decimal discountedFare: type: number description: "Gets or Sets the DiscountedFare for this reservation.\n \ \ " format: decimal currencyCode: type: string description: "Gets or Sets the CurrencyCode for the agent that requested\ \ the printing.\n " nullable: true contactPhone: type: string description: "Gets or Sets the ContactPhone for this reservation.\n \ \ " nullable: true fareBasisCode: type: string description: "Gets or Sets the FareBasisCode for this reservation.\n \ \ " nullable: true fareClass: type: string description: "Gets or Sets the FareClass for this reservation.\n \ \ " nullable: true gender: type: string description: "Gets or Sets the Gender for this passenger.\n " nullable: true passengerId: type: integer description: "Gets or Sets the PassengerId for this passenger.\n \ \ " format: int64 passengerTypeTag: type: string description: "Gets or Sets the PassengerTypeTag for this reservation.\n\ \ " nullable: true passportCountry: type: string description: "Gets or Sets the PassportCountry for this reservation.\n \ \ " nullable: true passportExpiryDate: type: string description: "Gets or Sets the PassportExpiryDate for this passenger.\n\ \ " format: date-time passportNumber: type: string description: "Gets or Sets the PassportNumber for this passenger.\n \ \ " nullable: true dateOfBirth: type: string description: "Gets or Sets the DateOfBirth for this passenger.\n \ \ " format: date-time paymentDate: type: string description: "Gets or Sets the Payment date for this passenger.\n \ \ " format: date-time paymentDescription: type: string description: "Gets or Sets the payment description for this reservation.\n\ \ " nullable: true stationID: type: string description: "Gets or Sets the StationID for this reservation.\n \ \ " nullable: true receiptNumber: type: string description: "Gets or Sets the ReceiptNumber for this boarding pass.\nThis\ \ is a 9 digit number that is zero padded on the left.\nThe number is\ \ made from the last 9 digits of the passengerID\n " nullable: true currentTime: type: string description: "Gets or Sets the CurrentTime this boarding pass was requested.\n\ \ " format: date-time agentID: type: string description: "Gets or Sets the agentID for the agent that requested the\ \ printing.\n " nullable: true iataid: type: string description: "Gets or Sets the IATAID for the boarding pass.\n \ \ " nullable: true guestValueLevelName: type: string description: "Gets or Sets the GuestValueLevelName.\n " nullable: true guestValueLevelCode: type: string description: "Gets or Sets the GuestValueLevelCode.\n " maxLength: 1 boardingMessage: type: string description: "Gets or Sets the BoardingMessage.\n " nullable: true infant: description: "Gets the Infant associated this passenger.\n " nullable: true $ref: '#/components/schemas/BoardingPassScanInfant' barCode: description: "Gets the BarCode.\n " nullable: true $ref: '#/components/schemas/BoardingPassScanBarCode' segments: type: array description: "Gets collection of BoardingPassSegment objects.\n \ \ " nullable: true items: $ref: '#/components/schemas/BoardingPassScanSegment' serviceCharges: type: array description: "Gets collection of Service objects.\n " nullable: true items: $ref: '#/components/schemas/BoardingPassScanServiceCharge' documents: type: array description: "Gets and sets the collection of Document objects.\n \ \ " nullable: true items: $ref: '#/components/schemas/GoNowDocument' calculations: type: array description: "list of reservations related monetary calculations\nkey of\ \ the dictionary is referened to CalculationType constants\n \ \ " nullable: true items: $ref: '#/components/schemas/BoardingPassScanCalculation' isoTitle: type: string description: "ISO Title\n " nullable: true isoSuffix: type: string description: "ISO Suffix\n " nullable: true isoFirstName: type: string description: "ISO First name\n " nullable: true isoMiddleName: type: string description: "ISO Middle name\n " nullable: true isoLastName: type: string description: "ISO Last Name\n " nullable: true infantIndicator: type: boolean description: "This indicates if the boarding pass if for an\nInfant without\ \ a seat (INFT, etc)\n " BoardingPassScanInfant: type: object description: "Boarding pass scan infant\n " additionalProperties: false properties: countryOfResidence: type: string description: "CountryOfResidence\n " nullable: true nationality: type: string description: "CountryOfResidence\n " nullable: true dateOfBirth: type: string description: "DateOfBirth\n " format: date-time gender: type: string description: "Gender\n " nullable: true doesNameExist: type: boolean description: "Does name exist flag\n " title: type: string description: "DOCTODO\n " nullable: true suffix: type: string description: "DOCTODO\n " nullable: true firstName: type: string description: "DOCTODO\n " nullable: true middleName: type: string description: "DOCTODO\n " nullable: true lastName: type: string description: "DOCTODO\n " nullable: true paxInfoFieldsForIatciUpdate: type: array description: "Contains list of passenger fields that needs an IATCI update.\n\ \ " nullable: true items: type: string isoTitle: type: string description: "DOCTODO\n " nullable: true isoSuffix: type: string description: "DOCTODO\n " nullable: true isoFirstName: type: string description: "DOCTODO\n " nullable: true isoMiddleName: type: string description: "DOCTODO\n " nullable: true isoLastName: type: string description: "DOCTODO\n " nullable: true BoardingPassScanBarCode: type: object description: "Represents a bar code on a boarding pass scan\n " additionalProperties: false properties: barCodeData: type: string description: "Gets and Sets the BarCodeData.\n " nullable: true barCodeType: type: string description: "Gets and Sets the BarCodeType.\n " nullable: true BoardingPassScanSegment: type: object description: "Represents a Segment on a boarding pass scan\n " additionalProperties: false properties: departureDateTime: type: string description: "Departure date time\n " format: date-time carrierCode: type: string description: "Carrier code\n " nullable: true flightNumber: type: string description: "Flight number\n " nullable: true opSuffix: type: string description: "Op suffix\n " maxLength: 1 departureStation: type: string description: "Departure station\n " nullable: true arrivalStation: type: string description: "Arrival station\n " nullable: true airlineName: type: string description: "Airline name\n " nullable: true arrivalDateTime: type: string description: "Arrival date time\n " format: date-time departureGate: type: string description: "Departure gate\n " nullable: true departureStationName: type: string description: "Departure station name\n " nullable: true arrivalStationName: type: string description: "Arrival station name\n " nullable: true boardingTime: type: string description: "Boarding time\n " format: date-time connectionInd: type: boolean description: "Connection indicator\n " segmentType: type: string description: "Segment type\n " nullable: true bookingStatus: type: string description: "Booking status\n " nullable: true international: type: boolean description: "International indicator\n " cabinOfService: type: string description: "Cabin of service\n " maxLength: 1 ticketIndicator: type: string description: "Ticket indicator\n " nullable: true ticketNumber: type: string description: "Ticket number\n " nullable: true classOfService: type: string description: "Class of service\n " nullable: true verifiedTravelDocs: type: string description: "Verified travel documents\n " nullable: true fareClassName: type: string description: "Fare class name\n " nullable: true productClassName: type: string description: "Product class name\n " nullable: true infantInd: type: boolean description: "Infant indicator\n " infantTicketNumber: type: string description: "Infant ticket number\n " nullable: true otherClassOfService: type: string description: "Other class of service\n " nullable: true otherCarrierCode: type: string description: "other carrier code\n " nullable: true otherCarrierName: type: string description: "Other carrier name\n " nullable: true otherFlightNumber: type: string description: "Other flight number\n " nullable: true otherOpSuffix: type: string description: "Other op suffix\n " maxLength: 1 barCodes: type: array description: "Bar codes\n " nullable: true items: $ref: '#/components/schemas/BoardingPassScanBarCode' legs: type: array description: "Segment legs\n " nullable: true items: $ref: '#/components/schemas/BoardingPassScanLeg' programName: type: string description: "Program name\n " nullable: true programLevelShortName: type: string description: "Program level code\n " nullable: true programNumber: type: string description: "Program number\n " nullable: true otherRecordLocator: type: string description: "Other record locator\n " nullable: true programCode: type: string description: "Program code\n " nullable: true freeBaggageAllowance: type: string description: "Free baggage allowance\n " nullable: true BoardingPassScanLeg: type: object description: "Represents a leg on a boarding pass scan\n " additionalProperties: false properties: departureDateTime: type: string description: "Departure date time\n " format: date-time carrierCode: type: string description: "Carrier code\n " nullable: true flightNumber: type: string description: "Flight number\n " nullable: true opSuffix: type: string description: "Op suffix\n " maxLength: 1 departureStation: type: string description: "Departure station\n " nullable: true arrivalStation: type: string description: "Arrival station\n " nullable: true legNumber: type: integer description: "Leg number\n " boardingSequence: type: integer description: "Boarding sequence\n " liftStatus: type: string description: "Lift status\n " nullable: true boardingZone: type: integer description: "Boarding zone\n " aircraftType: type: string description: "Aircraft type\n " nullable: true aircraftTypeSuffix: type: string description: "Aircraft type suffix\n " nullable: true operatingCarrier: type: string description: "Operating carrier\n " nullable: true operatingCarrierName: type: string description: "Operating carrier name\n " nullable: true operatingFlightNumber: type: string description: "Operating flight number\n " nullable: true operatedByText: type: string description: "Operated by text\n " nullable: true operatingOpSuffix: type: string description: "Operating Op Suffix\n " maxLength: 1 sta: type: string description: "STA.\n " format: date-time subjectToGovtApproval: type: boolean description: "Subject to government approval\n " codeShareIndicator: type: string description: "Code share indicator\n " maxLength: 1 compartmentDesignator: type: string description: "Compartment designator\n " nullable: true seatInfo: type: string description: "Seat info\n " nullable: true seatRow: type: string description: "Seat row\n " nullable: true seatColumn: type: string description: "Seat column\n " nullable: true unitDesignator: type: string description: "Unit designator\n " nullable: true baggage: type: array description: "Baggage\n " nullable: true items: $ref: '#/components/schemas/BoardingPassScanBaggage' ssrs: type: array description: "Ssrs\n " nullable: true items: $ref: '#/components/schemas/BoardingPassScanSsr' oaBoardingZone: type: string description: "OA Boarding zone\n " nullable: true aircraftChange: type: boolean description: "Aircraft change indicator\n " bppr: type: string description: "Bppr\n " nullable: true authorizationList: type: array description: "Authorization list\n " nullable: true items: $ref: '#/components/schemas/BoardingPassScanAuthorization' bpprText: type: string description: "Bppr text\n " nullable: true BoardingPassScanBaggage: type: object description: "Boarding pass scan baggage\n " additionalProperties: false properties: bagTag: type: string description: "BagTag\n " nullable: true tagDate: type: string description: "Tag date\n " format: date-time originStation: type: string description: "Origin station\n " nullable: true weight: description: "Weight\n " nullable: true $ref: '#/components/schemas/BoardingPassScanBaggageWeight' taggedToStation: type: string description: "Tagged to station\n " nullable: true taggedToFlightNumber: type: string description: "Tagged to flight number\n " nullable: true baggageStatus: type: string description: "Baggage status\n " nullable: true compartmentId: type: integer description: "Compartment ID\n " lrtIndicator: type: boolean description: "LRT Indicator\n " taggedToCarrierCode: type: string description: "Tagged to carrier code\n " nullable: true taggedToStationCity: type: string description: "Tagged to station city\n " nullable: true baggageType: type: string description: "Baggage Type\n " nullable: true BoardingPassScanBaggageWeight: type: object description: "Boarding pass scan baggage weight\n " additionalProperties: false properties: value: type: number description: "Value.\nThe weight of the baggage in numbers\n " format: decimal unitOfMeasure: type: string description: "UnitOfMeasure\nThe unit of measurement used for the bag either\ \ in pounds or kilos or any new\nmeasurement in the future.\n \ \ " nullable: true BoardingPassScanSsr: type: object description: "Boarding pass scan SSR\n " additionalProperties: false properties: note: type: string description: "Note\n " nullable: true ssrCode: type: string description: "Ssr code\n " nullable: true ssrDetail: type: string description: "Ssr detail\n " nullable: true ssrNumber: type: integer description: "Ssr number\n " BoardingPassScanAuthorization: type: object description: "Boarding pass authorization\n " additionalProperties: false properties: driverName: type: string description: "Driver name\n " nullable: true authorizationStatus: type: string description: "Authorization status\n " nullable: true boardingPassPrintText: type: string description: "Boarding pass print text\n " nullable: true isInfant: type: boolean description: "Is infant indicator\n " screeningType: type: string description: "Screening type\n " nullable: true BoardingPassScanServiceCharge: type: object description: "Boarding pass scan service charge\n " additionalProperties: false properties: amount: type: number description: "Amount\n " format: decimal chargeCode: type: string description: "Charge code\n " nullable: true chargeDetail: type: string description: "Charge detail\n " nullable: true boardingPassServiceType: type: string description: "Boarding pass service type\n " nullable: true currencyCode: type: string description: "Currency code\n " nullable: true foreignAmount: type: number description: "Foreign amount\n " format: decimal foreignCurrencyCode: type: string description: "Foreign currency code\n " nullable: true ticketCode: type: string description: "Ticket code\n " nullable: true GoNowDocument: type: object description: "A scan document\n " additionalProperties: false properties: typeCode: type: string description: "Type Code\n " nullable: true type: type: string description: "The type\n " nullable: true issuingCountryCode: type: string description: "The issuing country\n " nullable: true documentDetails: type: array description: "Document details in key-value pairs\n " nullable: true items: $ref: '#/components/schemas/DataField' DataField: type: object description: "Stores values in key-value pairs\n " additionalProperties: false properties: data: type: string description: "Data\n " nullable: true field: type: string description: "Field name\n " nullable: true BoardingPassScanCalculation: type: object description: "Boarding pass Calculation\n " additionalProperties: false properties: name: type: string description: "Name\n " nullable: true value: type: number description: "Value\n " format: decimal CreditCardScan: type: object description: "A credit card scan.\n " additionalProperties: false properties: scanType: type: string description: "Gets or sets the Scan Type of the Scan.\n " nullable: true paymentType: type: string description: "Payment type\n " nullable: true creditCardNumber: type: string description: "Credit card number\n " nullable: true expirationDate: type: string description: "Expiration date\n " format: date-time creditCardHolder: type: string description: "Credit card holder\n " nullable: true title: type: string description: "Title\n " nullable: true suffix: type: string description: "Suffix\n " nullable: true firstName: type: string description: "First Name\n " nullable: true middleName: type: string description: "Middle name\n " nullable: true lastName: type: string description: "Last name\n " nullable: true DocumentScan: type: object description: "A Document scan\n " additionalProperties: false properties: scanType: type: string description: "Gets or sets the Scan Type of the Scan.\n " nullable: true document: description: "The document details\n " nullable: true $ref: '#/components/schemas/GoNowDocument' firstName: type: string description: "First name\n " nullable: true middleName: type: string description: "Middle name\n " nullable: true lastName: type: string description: "Last name\n " nullable: true ItineraryScan: type: object description: "An itinerary scan\n " additionalProperties: false properties: scanType: type: string description: "Gets or sets the Scan Type of the Scan.\n " nullable: true flightNumber: type: string description: "Flight Number\n " nullable: true departureStation: type: string description: "Departure station\n " nullable: true arrivalStation: type: string description: "Arrival station\n " nullable: true MembershipCardScan: type: object description: "A membership card scan\n " additionalProperties: false properties: scanType: type: string description: "Gets or sets the Scan Type of the Scan.\n " nullable: true membershipCardNumber: type: string description: "Membership card number\n " nullable: true expirationDate: type: string description: "Expiration date\n " format: date-time tierCode: type: string description: "Tier code\n " nullable: true carrierCode: type: string description: "Carrier code\n " nullable: true title: type: string description: "Title\n " nullable: true suffix: type: string description: "Suffix\n " nullable: true firstName: type: string description: "First Name\n " nullable: true middleName: type: string description: "Middle name\n " nullable: true lastName: type: string description: "Last name\n " nullable: true RecordLocatorScan: type: object description: "A record locator scan\n " additionalProperties: false properties: scanType: type: string description: "Gets or sets the Scan Type of the Scan.\n " nullable: true recordLocator: type: string description: "Record locator\n " nullable: true KioskVerifyTravelDocumentRequest: type: object description: "Defines the request for the Kiosk Verify Travel Document\n \ \ " additionalProperties: false required: - scannedDocuments properties: scannedDocuments: type: array description: "Collection of VerifiedDocumentRequest\n " items: $ref: '#/components/schemas/VerifiedDocumentRequest' VerifiedDocumentRequest: type: object description: "Verified Document Request\n " additionalProperties: false required: - scan - travelDocumentKey properties: scan: description: "The scan to verify the document with.\n " $ref: '#/components/schemas/LocationParseRequest' travelDocumentKey: type: string description: "The document being verified.\n " minLength: 1 securitySchemes: JWT: type: http description: Paste your JWT token from the token endpoint. scheme: bearer bearerFormat: jwt security: - JWT: []