openapi: 3.2.0 info: title: NewSkies-Digital-Api Persons API version: 4.8.6.23 description: Navitaire Digital Api servers: - url: https://prod.api.tui/flight/newskies/rest description: TUI Prod - url: https://playground.api.tui/flight/newskies/rest description: TUI Playground security: - JWT: [] tags: - name: persons paths: /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\nresponse from the previous set of paged results.\n " schema: type: - integer - 'null' format: int32 x-position: 1 - name: Username in: query description: "The person user name to search by.\n " schema: type: - string - 'null' x-position: 2 - name: FirstName in: query description: "The person's first name to search by.\n " schema: type: - string - 'null' x-position: 3 - name: LastName in: query description: "The person's last name to search by.\n " schema: type: - string - 'null' 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: $ref: '#/components/schemas/MatchCriteria' x-position: 5 - name: CustomerNumber in: query description: "The person's customer number.\n " schema: type: - string - 'null' x-position: 6 - name: PhoneNumber in: query description: "The phone number to search by.\n " schema: type: - string - 'null' x-position: 7 - name: EmailAddress in: query description: "The email address to search by.\n " schema: type: - string - 'null' x-position: 8 - name: ProgramNumber in: query description: "The program number to search by.\n " schema: type: - string - 'null' x-position: 9 - name: ProgramCode in: query description: "The program code to search by.\n " schema: type: - string - 'null' x-position: 10 - name: Type in: query description: "The person type to search by.\n \nEnumeration values: 0 = None, 1 = Customer, 2 = Agent" schema: $ref: '#/components/schemas/PersonType' x-position: 11 - name: NationalIdNumber in: query description: "The national ID number to search by.\n " schema: type: - string - 'null' 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: $ref: '#/components/schemas/MatchCriteria' x-position: 13 - name: ReturnCount in: query description: "The number of results to return.\n " schema: type: - integer - 'null' 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: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.' type: Validation details: null rawMessage: 'A first name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>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: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>.' type: Validation details: null rawMessage: 'A middle name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>.' exception: null debugMode: The API 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: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.' type: Validation details: null rawMessage: 'A last name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>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: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.' type: Validation details: null rawMessage: 'A first name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>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: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>.' type: Validation details: null rawMessage: 'A middle name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>.' exception: null debugMode: The API 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: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>0123456789.' type: Validation details: null rawMessage: 'A last name may not begin with any of these characters: :@#$%&_+*-=~^`“"''‘,.:;!?|/\(){}[]<>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 - 'null' 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 - 'null' format: date-time x-position: 3 - name: EndTime in: query description: "The end date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time 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 - 'null' maximum: 5000.0 minimum: 10.0 x-position: 6 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n " schema: type: - integer - 'null' format: int64 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 - 'null' format: date-time x-position: 3 - name: EndDate in: query description: "The end date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time 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 - 'null' maximum: 5000.0 minimum: 10.0 x-position: 6 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: - string - 'null' 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 - 'null' format: date-time x-position: 2 - name: EndTime in: query description: "The end date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time 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 - 'null' maximum: 5000.0 minimum: 10.0 x-position: 5 - name: PageIndex in: query description: "Represents the index of the requested paged item.\n " schema: type: - integer - 'null' format: int64 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 - 'null' format: date-time x-position: 2 - name: EndDate in: query description: "The end date and time of the date range to search in.\n " schema: type: - string - 'null' format: date-time 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 - 'null' maximum: 5000.0 minimum: 10.0 x-position: 5 - name: LastPageKey in: query description: "The last page key where to start paged query.\n " schema: type: - string - 'null' 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' components: schemas: 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 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 - 'null' description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 transactionCode: type: - string - 'null' description: "The transaction code.\n " maxLength: 6 minLength: 0 expiration: type: - string - 'null' description: "The account collection expiration.\n " format: date-time 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 - 'null' description: "The collection of registered email address.\n " items: $ref: '#/components/schemas/PersonEmail' phoneNumbers: type: - array - 'null' description: "The collection of registered phone numbers.\n " items: $ref: '#/components/schemas/PersonPhoneNumber' addresses: type: - array - 'null' description: "The collection of known addresses.\n " items: $ref: '#/components/schemas/PersonAddress' storedPayments: type: - array - 'null' description: "The collection of registered stored payments.\n " items: $ref: '#/components/schemas/PersonStoredPayment' travelDocuments: type: - array - 'null' description: "The collection of registered travel documents.\n " items: $ref: '#/components/schemas/PersonTravelDocument' programs: type: - array - 'null' description: "The collection of enrolled customer programs.\n " items: $ref: '#/components/schemas/PersonCustomerProgram' comments: type: - array - 'null' description: "The collection of comments.\n " items: $ref: '#/components/schemas/PersonComment' preferences: type: - array - 'null' description: "The collection of preferences.\n " items: $ref: '#/components/schemas/PersonPreference' aliases: type: - array - 'null' description: "The collection of alternate names for the person.\n " items: $ref: '#/components/schemas/PersonAlias' affiliates: type: - array - 'null' description: "The collection of affiliations for the person.\n " items: $ref: '#/components/schemas/PersonAffiliation' customerNumber: type: - string - 'null' description: "The unique person customer number.\n " maxLength: 20 minLength: 0 type: description: "The type of person.\n " $ref: '#/components/schemas/PersonType' status: description: "The status of the person.\n " $ref: '#/components/schemas/PersonStatus' details: description: "The person's basic information.\n " $ref: '#/components/schemas/PersonBasicInformation' notificationPreference: description: "The person's notification preference.\n " $ref: '#/components/schemas/NotificationPreference' personKey: type: - string - 'null' description: "The unique person key.\n " createdDate: type: string description: "The date the record was created.\n " format: date-time 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 - 'null' description: "The last page key.\n " transactions: type: - array - 'null' description: "The collection of transactions.\n " items: $ref: '#/components/schemas/Transaction' PersonRecordsResponse: type: object description: "Defines the person record response.\n " additionalProperties: false properties: records: type: - array - 'null' description: "The person records search results.\n " items: $ref: '#/components/schemas/PersonRecord' lastIndex: type: integer description: "The last index of the paged response.\n " format: int64 IJsonResponseOfIListOfPersonStoredPayment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonStoredPayment' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPersonCustomerProgram: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonCustomerProgram' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPersonTravelNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonTravelNotification' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PersonStatus: type: integer description: "The status of the person.\n \n\n0 = Active\n1 = Terminated\n2 = Suspended" x-enumNames: - Active - Terminated - Suspended enum: - 0 - 1 - 2 IJsonResponseOfPersonRecordsResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonRecordsResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' 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 - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 personAddressKey: type: - string - 'null' description: "The unique person address key.\n " 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' 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 - 'null' description: "The effective date.\n " format: date-time expirationDate: type: - string - 'null' description: "The expiration date.\n " format: date-time default: type: boolean description: "True if this is set as the default program.\n " programLevelCode: type: - string - 'null' description: "The program level.\n " maxLength: 3 minLength: 0 IJsonResponseOfPersonPreference: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonPreference' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' DeltaMapperOfPersonPreferenceEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: value: type: - string - 'null' description: "The value of the preference.\n " IJsonResponseOfPersonAddress: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonAddress' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PersonPreferenceEditRequest: type: object description: "Defines the person preference edit request.\n " additionalProperties: false properties: value: type: - string - 'null' description: "The value of the preference.\n " Account: type: object description: "The account model.\n " additionalProperties: false properties: accountKey: type: - string - 'null' description: "The account key.\n " 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 - 'null' description: "The foreign currency code.\n " accountNumber: type: - string - 'null' description: "The account number associated to the customer or organization.\n " expiredCreditAmount: type: number description: "The amount of credit that was unused and already expired.\n " format: decimal expiredCreditCurrencyCode: type: - string - 'null' description: "The currency code of the expired credit amount.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 collections: type: - array - 'null' description: "The list of account collections.\n " items: $ref: '#/components/schemas/AccountCollection' accountName: type: - string - 'null' description: "The account name associated to the customer.\n " IJsonResponseOfIListOfPersonPhoneNumber: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonPhoneNumber' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PaymentMethodType: type: integer description: "Defines the payment method types.\n \n\n0 = ExternalAccount\n1 = PrePaid\n2 = AgencyAccount\n3 = CustomerAccount\n4 = Voucher\n5 = Loyalty" x-enumNames: - ExternalAccount - PrePaid - AgencyAccount - CustomerAccount - Voucher - Loyalty enum: - 0 - 1 - 2 - 3 - 4 - 5 AccountCollection: type: object description: "The account collection model.\n " additionalProperties: false properties: accountCollectionKey: type: - string - 'null' description: "The unique account collection key.\n " available: type: number description: "The available amount.\n " format: decimal amount: type: number description: "The total amount.\n " format: decimal createdDate: type: - string - 'null' description: "The creation date.\n " format: date-time transactionCode: type: - string - 'null' description: "The transaction code.\n " expiration: type: - string - 'null' description: "The expiration date.\n " format: date-time spoiledAmount: type: number description: "The spoiled amount.\n " format: decimal IJsonResponseOfPersonAffiliation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonAffiliation' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PersonEditRequest: type: object description: "Defines the person create request.\n " additionalProperties: false required: - name properties: type: description: "The type of person.\n " $ref: '#/components/schemas/PersonType' status: description: "The status of the person.\n " $ref: '#/components/schemas/PersonStatus' details: description: "The person's basic information.\n " $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' IJsonResponseOfNotificationEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/NotificationEvent' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPersonComment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonComment' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PersonAddressEditRequest: type: object description: "Defines the person address edit request.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 default: type: boolean description: "Flag indicating if the address is the persons default.\n " NotificationTimedEventType: type: integer description: "Represents the type of timed notification event type for a travel notification event.\nThese are events that have an associated property minutes to event.\n \n\n0 = Departure\n1 = Arrival" x-enumNames: - Departure - Arrival enum: - 0 - 1 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 - 'null' description: "The unique key for the phone number.\n " PersonInformationEditRequest: type: object description: "Defines a person information edit request.\n " additionalProperties: false properties: data: type: - string - 'null' description: "The information data.\n " 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 " DeltaMapperOfTravelDocumentEditRequestv2: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time default: type: boolean description: "Flag indicating if the travel document is the default.\n " gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ 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 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 - 'null' description: "The unique email key.\n " PersonPreferenceCreateRequest: type: object description: "Defines a person preference create request.\n " additionalProperties: false properties: value: type: - string - 'null' description: "The value of the preference.\n " code: type: - string - 'null' description: "The preference code.\n " IJsonResponseOfPerson: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Person' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonStoredPayment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonStoredPayment' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' TravelNotificationCreateRequest: type: object description: "Create request for travel notifications.\n " additionalProperties: false properties: cultureCode: type: - string - 'null' description: "The culture code.\n " notificationDestination: description: "The notification destination.\n " $ref: '#/components/schemas/NotificationDestination' deviceName: type: - string - 'null' description: "The name of the device for the push notification.\n " events: type: - array - 'null' description: "The list of travel notification event.\n " items: $ref: '#/components/schemas/NotificationEventCreateRequest' timedEvents: type: - array - 'null' description: "The list of travel notification event.\n " items: $ref: '#/components/schemas/NotificationTimedEventCreateRequest' PersonTravelNotification: type: object description: "A person travel notification.\n " additionalProperties: false properties: travelNotificationKey: type: - string - 'null' description: "The travel notification key.\n " events: type: - array - 'null' description: "The list of travel notification event.\n " items: $ref: '#/components/schemas/NotificationEvent' timedEvents: type: - array - 'null' description: "The list of travel notification event.\n " items: $ref: '#/components/schemas/NotificationTimedEvent' cultureCode: type: - string - 'null' description: "The culture code.\n " notificationDestination: description: "The notification destination.\n " $ref: '#/components/schemas/NotificationDestination' deviceName: type: - string - 'null' description: "The name of the device for the push notification.\n " createdDate: type: - string - 'null' description: "The created date of the travel notification.\n " format: date-time IJsonResponseOfIListOfNotificationEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/NotificationEvent' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' 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 - 'null' description: "The name of the account.\n " maxLength: 64 minLength: 0 expiration: type: - string - 'null' description: "The expiration.\n " format: date-time 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 " IJsonResponseOfIListOfPersonInformation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonInformation' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' DeltaMapperOfPersonAddressEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 default: type: boolean description: "Flag indicating if the address is the persons default.\n " PersonCommentRequest: type: object description: "Defines a person comment request.\n " additionalProperties: false properties: text: type: - string - 'null' description: "The comments text.\n " type: description: "The comment type.\n " $ref: '#/components/schemas/PersonCommentType' 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 - 'null' description: "The name of the account.\n " maxLength: 64 minLength: 0 expiration: type: - string - 'null' description: "The expiration.\n " format: date-time 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 " 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 - 'null' description: "The issuer code for the travel document (country code).\n " maxLength: 3 minLength: 0 birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " $ref: '#/components/schemas/Name' nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: - string - 'null' description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ personTravelDocumentKey: type: - string - 'null' description: "The unique person travel document key.\n " 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 TravelNotificationEditRequest: type: object description: "Request base for travel notifications.\n " additionalProperties: false properties: cultureCode: type: - string - 'null' description: "The culture code.\n " notificationDestination: description: "The notification destination.\n " $ref: '#/components/schemas/NotificationDestination' deviceName: type: - string - 'null' description: "The name of the device for the push notification.\n " 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 - 'null' description: "The effective date.\n " format: date-time expirationDate: type: - string - 'null' description: "The expiration date.\n " format: date-time default: type: boolean description: "True if this is set as the default program.\n " programLevelCode: type: - string - 'null' description: "The program level.\n " maxLength: 3 minLength: 0 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 IJsonResponseOfIListOfPersonEmail: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonEmail' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' 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 - 'null' description: "The issuer code for the travel document (country code).\n " maxLength: 3 minLength: 0 birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " $ref: '#/components/schemas/Name' nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: - string - 'null' description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, numbers, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ default: type: boolean description: "Flag indicating if the travel document is the default.\n " IJsonResponseOfPersonEmail: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonEmail' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' 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 " 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 " $ref: '#/components/schemas/PersonType' status: description: "The status of the person.\n " $ref: '#/components/schemas/PersonStatus' details: description: "The person's basic information.\n " properties: gender: description: "The person's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time nationality: type: - string - 'null' description: "The person's nationality.\n " residentCountry: type: - string - 'null' description: "The person's resident country.\n " passengerType: type: - string - 'null' description: "The type of passenger the person is.\n " preferredCultureCode: type: - string - 'null' description: "The person's preferred culture code.\n " preferredCurrencyCode: type: - string - 'null' description: "The person's preferred currency code.\n " nationalIdNumber: type: - string - 'null' description: "The person's national ID number.\n " declaredGender: type: - string - 'null' 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 notificationPreference: description: "The person's notification preference.\n " $ref: '#/components/schemas/NotificationPreference' name: description: "The persons true name.\n " properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 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 - 'null' description: "The unique person affiliation key.\n " 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 IJsonResponseOfIListOfPersonAffiliation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonAffiliation' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfPagedTransactionResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PagedTransactionResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PersonComment: type: object description: "Defines a person comment.\n " additionalProperties: false properties: text: type: - string - 'null' description: "The comments text.\n " type: description: "The comment type.\n " $ref: '#/components/schemas/PersonCommentType' personCommentKey: type: - string - 'null' description: "The unique person comment key.\n " createdUserKey: type: - string - 'null' description: "The unique user key of the agent that created the comment.\n " createdDate: type: string description: "The date the comment was created.\n " format: date-time modifiedUserKey: type: - string - 'null' description: "The unique user key of the agent that last modified the comment.\n " modifiedDate: type: string description: "The date the comment was last modified.\n " format: date-time 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' 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 - 'null' description: "The created date.\n " format: date-time modifiedDate: type: - string - 'null' description: "The modified date.\n " format: date-time 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 - 'null' description: "The effective date.\n " format: date-time expirationDate: type: - string - 'null' description: "The expiration date.\n " format: date-time default: type: boolean description: "True if this is set as the default program.\n " programLevelCode: type: - string - 'null' description: "The program level.\n " maxLength: 3 minLength: 0 personCustomerProgramKey: type: - string - 'null' description: "The unique person customer program key.\n " PhoneNumberType: type: integer description: "Defines the types of phone numbers. Note: New Skies does not support Mobile for booking contacts.\n \n\n0 = Other\n1 = Home\n2 = Work\n3 = Mobile\n4 = Fax" x-enumNames: - Other - Home - Work - Mobile - Fax enum: - 0 - 1 - 2 - 3 - 4 IJsonResponseOfAccount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Account' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' 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 - 'null' description: "The name of the account.\n " maxLength: 64 minLength: 0 expiration: type: - string - 'null' description: "The expiration.\n " format: date-time 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 Message: type: object description: "Defines a unique informational message.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The unique message code.\n " type: type: - string - 'null' description: "The message type.\n " value: type: - string - 'null' description: "The message's value.\n " status: description: "The message's status.\n " $ref: '#/components/schemas/MessageStatus' details: type: - object - 'null' description: "Dynamic detailed information about the message.\n " additionalProperties: type: string PersonCreateRequest: type: object description: "Defines the person create request.\n " additionalProperties: false required: - name properties: customerNumber: type: - string - 'null' description: "The unique person customer number.\n " maxLength: 20 minLength: 0 type: description: "The type of person.\n " $ref: '#/components/schemas/PersonType' status: description: "The status of the person.\n " $ref: '#/components/schemas/PersonStatus' details: description: "The person's basic information.\n " $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 - 'null' description: "The collection of registered email address.\n " items: $ref: '#/components/schemas/EmailCreateRequest' phoneNumbers: type: - array - 'null' description: "The collection of registered phone numbers.\n " items: $ref: '#/components/schemas/PersonPhoneNumberRequest' addresses: type: - array - 'null' description: "The collection of known addresses.\n " items: $ref: '#/components/schemas/PersonAddressCreateRequest' storedPayments: type: - array - 'null' description: "The collection of registered stored payments.\n " items: $ref: '#/components/schemas/PersonStoredPaymentRequest' travelDocuments: type: - array - 'null' description: "The collection of registered travel documents.\n " items: $ref: '#/components/schemas/PersonTravelDocumentRequest' programs: type: - array - 'null' description: "The collection of enrolled customer programs.\n " items: $ref: '#/components/schemas/PersonCustomerProgramCreateRequest' comments: type: - array - 'null' description: "The collection of comments.\n " items: $ref: '#/components/schemas/PersonCommentRequest' preferences: type: - array - 'null' description: "The collection of preferences.\n " items: $ref: '#/components/schemas/PersonPreferenceCreateRequest' aliases: type: - array - 'null' description: "The collection of alternate names for the person.\n " items: $ref: '#/components/schemas/PersonAliasRequest' affiliates: type: - array - 'null' description: "The collection of affiliates for the person.\n " items: $ref: '#/components/schemas/PersonAffiliation' 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 - 'null' description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 accountTransactionCode: type: - string - 'null' description: "The system-generated code for the transaction.\n " recordLocator: type: - string - 'null' 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. accountReference: type: - string - 'null' 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 " transactionKey: type: - string - 'null' description: "The unique transaction key.\n " createdDate: type: - string - 'null' description: "The created date associated with the transaction.\n " format: date-time foreignAmount: type: number description: "The transaction foreign amount.\n " format: decimal foreignCurrencyCode: type: - string - 'null' description: "The transaction foreign currency code.\n " maxLength: 3 minLength: 0 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 - 'null' description: "The account collection key associated with the transaction.\n " IJsonResponseOfPersonAlias: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonAlias' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponse: type: object description: "Defines the JSON response contract for a not content type response.\n " additionalProperties: false properties: data: description: "The payload data, this will always be null for errors responses and no content responses.\n " errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' DeliveryMethodCode: type: integer description: "Represents the delivery method codes.\n \n\n0 = Email\n1 = Sms\n2 = Push" x-enumNames: - Email - Sms - Push enum: - 0 - 1 - 2 IJsonResponseOfNotificationTimedEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/NotificationTimedEvent' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonComment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonComment' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' 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 " $ref: '#/components/schemas/Name' customerProgramCodes: type: - array - 'null' description: "The list of customer program codes to be merged.\n " items: type: string 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 - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 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 PersonAliasType: type: integer description: "Defines the type of alternate name.\n \n\n0 = Alias\n1 = Variant" x-enumNames: - Alias - Variant enum: - 0 - 1 IJsonResponseOfIListOfPersonAlias: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonAlias' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonTravelDocument: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonTravelDocument' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PersonName: type: object description: "Defines a person name.\n " additionalProperties: false properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 personNameKey: type: - string - 'null' description: "The unique person name key.\n " 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 Exception: type: object additionalProperties: false properties: Message: type: string InnerException: $ref: '#/components/schemas/Exception' Source: type: - string - 'null' StackTrace: type: - string - 'null' TravelDocumentEditRequestv2: type: object description: "Defines the edit travel document request.\n " additionalProperties: false required: - number properties: birthCountry: type: - string - 'null' description: "The BirthCountry property.\n " name: description: "The Name property.\n " $ref: '#/components/schemas/Name' nationality: type: - string - 'null' description: "The Nationality property.\n " maxLength: 2 minLength: 0 expirationDate: type: - string - 'null' description: "The date when this travel document expires.\n " format: date-time number: type: string description: "The travel document number.\n " maxLength: 35 minLength: 0 issuedDate: type: - string - 'null' description: "The date this travel document was issued.\n " format: date-time default: type: boolean description: "Flag indicating if the travel document is the default.\n " gender: description: "The travel document holder's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time declaredGender: type: - string - 'null' description: "The travel document holder's declared gender.\nThis will override the gender field on passenger or person POST, PUT, and PATCH requests.\nNote: Any value other than \"F\" will cause gender to be updated to Male by default to support compatibility with\nother systems.\nAdditionally you cannot change the declared gender and gender fields at the same time as declared gender\nwill override any gender field value regardless of the value passed in.\n " maxLength: 2 minLength: 0 placeOfBirth: type: - string - 'null' description: "Represents the place of birth. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ placeOfIssue: type: - string - 'null' description: "Represents the place of issue. Only used on the following document type groups: TravelVisa (9), RedressNumber (20),\nand KnownTravelerId (21).\nOnly allows alpha characters, please do not use spaces, hyphens, or special characters.\nNote: If unsure which travel document types fall into these groups please use `/api/nsk/v1/resources/DocumentTypes`\nor `/api/nsk/v1/resources/DocumentTypes/{documentTypeCode}`\n " maxLength: 35 minLength: 0 pattern: ^[A-Za-z\s]*$ DeltaMapperOfPersonAliasRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 type: description: "The type of alias.\n " $ref: '#/components/schemas/PersonAliasType' IJsonResponseOfPersonCustomerProgram: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonCustomerProgram' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' DeltaMapperOfPersonCommentRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: text: type: - string - 'null' description: "The comments text.\n " type: description: "The comment type.\n " $ref: '#/components/schemas/PersonCommentType' DeltaMapperOfTravelNotificationEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: cultureCode: type: - string - 'null' description: "The culture code.\n " notificationDestination: description: "The notification destination.\n " properties: deliveryMethodCode: description: "The delivery method code.\n " $ref: '#/components/schemas/DeliveryMethodCode' destination: type: - string - 'null' description: "The notification destination, an email or phone number.\n " deviceName: type: - string - 'null' description: "The name of the device for the push notification.\n " Name: type: object description: "Defines a common name.\n " additionalProperties: false properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 Address: type: object description: "Defines a common address.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 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 " 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 IJsonResponseOfIListOfPersonTravelDocument: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonTravelDocument' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' 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 DeltaMapperOfPersonInformationEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: data: type: - string - 'null' description: "The information data.\n " PersonPreference: type: object description: "Defines the person preferences.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The preference code.\n " value: type: - string - 'null' description: "The value of the preference.\n " personPreferenceKey: type: - string - 'null' description: "The unique preference key.\n " 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\n4 = Transfer\n5 = Spoilage\n6 = StatementDateAndBalance\n7 = PayableCommission\n8 = 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 IJsonResponseOfPersonPhoneNumber: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonPhoneNumber' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonInformation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonInformation' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' AccountOwnerType: type: integer description: "The account owner type enumeration.\n \n\n0 = Organization\n1 = Personnal\n2 = Booking\n3 = Unknown" x-enumNames: - Organization - Personnal - Booking - Unknown enum: - 0 - 1 - 2 - 3 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 - 'null' description: "The effective date.\n " format: date-time expirationDate: type: - string - 'null' description: "The expiration date.\n " format: date-time default: type: boolean description: "True if this is set as the default program.\n " programLevelCode: type: - string - 'null' description: "The program level.\n " maxLength: 3 minLength: 0 programCode: type: string description: "The program code.\n " maxLength: 3 minLength: 0 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 - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 personAliasKey: type: - string - 'null' description: "The unique person alias key.\n " PersonAliasRequest: type: object description: "Defines the person alias request.\n " additionalProperties: false properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 type: description: "The type of alias.\n " $ref: '#/components/schemas/PersonAliasType' 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 " 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 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 IJsonResponseOfIListOfTransaction: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/Transaction' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' NotificationDestination: type: object description: "A travel notification destination.\n " additionalProperties: false required: - deliveryMethodCode properties: deliveryMethodCode: description: "The delivery method code.\n " $ref: '#/components/schemas/DeliveryMethodCode' destination: type: - string - 'null' description: "The notification destination, an email or phone number.\n " 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 - 'null' description: "The name of the account.\n " maxLength: 64 minLength: 0 expiration: type: - string - 'null' description: "The expiration.\n " format: date-time 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 - 'null' description: "The unique stored payment key.\n " NotificationEvent: type: object description: "A travel notification event.\n " additionalProperties: false required: - type properties: type: description: "The travel notification event type.\n " $ref: '#/components/schemas/NotificationEventType' createdDate: type: - string - 'null' description: "The created date of the travel notification.\n " format: date-time NotificationEventType: type: integer description: "Represents the type of notification event type for a travel notification event.\n \n\n0 = DepartureDelay\n1 = ArrivalDelay\n2 = ScheduleChange\n3 = CheckIn\n4 = GateInformation" x-enumNames: - DepartureDelay - ArrivalDelay - ScheduleChange - CheckIn - GateInformation enum: - 0 - 1 - 2 - 3 - 4 PersonInformationCreateRequest: type: object description: "Defines a person information create request.\n " additionalProperties: false required: - personInformationTypeCode properties: data: type: - string - 'null' description: "The information data.\n " 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 PersonRecord: type: object description: "Defines the person record.\n " additionalProperties: false properties: personKey: type: - string - 'null' description: "The unique person key.\n " 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 - 'null' description: "The person's customer number.\n " name: description: "The person's name.\n " $ref: '#/components/schemas/Name' phoneNumber: type: - string - 'null' description: "The person's default phone number.\n " emailAddress: type: - string - 'null' description: "The person's default email address.\n " address: description: "The person's default address.\n " $ref: '#/components/schemas/Address' programLoyaltyNumber: type: - string - 'null' description: "The person's default program loyalty number.\n " PersonType: type: integer description: "Defines the type of person.\n \n\n0 = None\n1 = Customer\n2 = Agent" x-enumNames: - None - Customer - Agent enum: - 0 - 1 - 2 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 - 'null' description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 NotificationTimedEvent: type: object description: "A travel notification timed event.\n " additionalProperties: false required: - type properties: type: description: "The travel notification timed event type.\n " $ref: '#/components/schemas/NotificationTimedEventType' minutesToEvent: type: integer description: "The minutes to the event.\n " format: int32 createdDate: type: - string - 'null' description: "The created date of the travel notification.\n " format: date-time PersonBasicInformation: type: object description: "Defines the person's basic information.\n " additionalProperties: false properties: gender: description: "The person's gender.\n " $ref: '#/components/schemas/Gender' dateOfBirth: type: - string - 'null' description: "The person's date of birth.\n " format: date-time nationality: type: - string - 'null' description: "The person's nationality.\n " residentCountry: type: - string - 'null' description: "The person's resident country.\n " passengerType: type: - string - 'null' description: "The type of passenger the person is.\n " preferredCultureCode: type: - string - 'null' description: "The person's preferred culture code.\n " preferredCurrencyCode: type: - string - 'null' description: "The person's preferred currency code.\n " nationalIdNumber: type: - string - 'null' description: "The person's national ID number.\n " declaredGender: type: - string - 'null' 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 ErrorResponse: type: object description: "Defines a unique error response.\n " additionalProperties: false properties: exception: description: "The original exception that was thrown and all the exception details.\n " $ref: '#/components/schemas/Exception' rawMessage: type: - string - 'null' description: "The original raw message set (non-localized).\n " code: type: - string - 'null' description: "The unique error code. The primary value used to match against a unique message localized for the end user in the\nchosen language.\n " message: type: - string - 'null' description: "The error message. Deprecated: Please use the Code instead.\n " type: type: - string - 'null' description: "The error type showing severity. Values: Critical, Error, Validation, Information.\n " number: type: - integer - 'null' description: "A unique identifier in numeric form. This is required for Splunk logging. If none is provided a number will be\ngenerated based on code and type.\n " format: int32 maximum: 99999.0 minimum: 0.0 details: type: - object - 'null' description: "Dynamic detailed information about the error.\n " additionalProperties: type: string ActivityId: type: - string - 'null' description: "The activity ID unique to the request. Useful for debugging purposes to uniquely look up what happened for this\nspecific request.\n " IJsonResponseOfIListOfNotificationTimedEvent: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/NotificationTimedEvent' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfPersonAddress: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonAddress' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfPersonTravelNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonTravelNotification' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' CreateAccountRequest: type: object description: "The create account request model.\n " additionalProperties: false properties: currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 IJsonResponseOfIListOfPersonPreference: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/PersonPreference' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' 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 - 'null' description: "The information data.\n " personInformationKey: type: - string - 'null' description: "The unique person information key.\n " securitySchemes: JWT: type: http description: Paste your JWT token from the token endpoint. scheme: bearer bearerFormat: jwt x-generator: NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))