openapi: 3.2.0 info: title: NewSkies-Digital-Api Resources 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: resources paths: /api/nsk/v1/resources/AccountTransactionCodes: get: tags: - resources summary: Retrieves the collection of account transaction code resources. description: 'GraphQL endpoint: resourceAccountTransactionCodes' operationId: nsk_v1_resources_AccountTransactionCodes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAccountTransactionCode' /api/nsk/v1/resources/AccountTransactionCodes/{transactionCode}: get: tags: - resources summary: Retrieves the specific account transaction code resource. description: 'GraphQL endpoint: resourceAccountTransactionCode' operationId: nsk_v1_resources_AccountTransactionCodes_transactionCode_get parameters: - name: transactionCode in: path required: true description: The desired transaction code to retrieve. schema: type: string x-position: 1 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: - string - '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/IJsonResponseOfAccountTransactionCode' /api/nsk/v1/resources/AddressTypes: get: tags: - resources summary: Retrieves the collection of address type resources. description: 'GraphQL endpoint: resourceAddressTypes' operationId: nsk_v1_resources_AddressTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAddressType' /api/nsk/v1/resources/AddressTypes/{addressTypeCode}: get: tags: - resources summary: Retrieves the specific address type resource. description: 'GraphQL endpoint: resourceAddressType' operationId: nsk_v1_resources_AddressTypes_addressTypeCode_get parameters: - name: addressTypeCode in: path required: true description: The unique type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfAddressType' /api/nsk/v1/resources/Areas: get: tags: - resources summary: Retrieves the collection of area resources. description: 'GraphQL endpoint: resourceAreas' operationId: nsk_v1_resources_Areas_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfArea' /api/nsk/v1/resources/Areas/{areaCode}: get: tags: - resources summary: Retrieves the specific area resource. description: 'See `/api/nsk/v1/resources/areas/{areaCode}/zones` to retrieve the list of geographical zones associated with a specific area. GraphQL endpoint: resourceArea' operationId: nsk_v1_resources_Areas_areaCode_get parameters: - name: areaCode in: path required: true description: The unique area code. schema: type: string x-position: 1 - name: cultureCode in: query description: The unique culture code. schema: type: - string - '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/IJsonResponseOfArea' /api/nsk/v1/resources/Areas/{areaCode}/zones: get: tags: - resources summary: Retrieves the collection of zones resources. description: 'GraphQL endpoint: resourceZonesv2' operationId: nsk_v1_resources_Areas_areaCode_zones_get parameters: - name: areaCode in: path required: true description: The unique code of the area to which the zones belong. schema: type: string x-position: 1 - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 2 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 3 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 4 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 6 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfZonev2' /api/nsk/v1/resources/Areas/{areaCode}/zones/{zoneCode}: get: tags: - resources summary: Retrieves the specific zone resource. description: 'GraphQL endpoint: resourceZonev2' operationId: nsk_v1_resources_Areas_areaCode_zones_zoneCode_get parameters: - name: areaCode in: path required: true description: The unique code of the area to which the zone belongs. schema: type: string x-position: 1 - name: zoneCode in: path required: true description: The unique zone code. schema: type: string x-position: 2 - name: cultureCode in: query description: The specific culture code. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfZonev2' /api/nsk/v1/resources/BaggageTypes: get: tags: - resources summary: Retrieves the collection of baggage type resources. description: 'GraphQL endpoint: resourceBaggageTypes' operationId: nsk_v1_resources_BaggageTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBaggageType' examples: Retrieve baggage types response: description: Example response for successfully retrieving the configured baggage types in the system. value: data: - baggageTypeCode: 1BAG bagWeightType: 2 freeBag: false inActive: false name: Booking Baggage Allowance weightReducedBy: 5 includeInBaggageCount: false - baggageTypeCode: BSMX bagWeightType: 2 freeBag: false inActive: false name: BSM ExceptionTesting weightReducedBy: 0 includeInBaggageCount: false - baggageTypeCode: BSM3 bagWeightType: 1 freeBag: false inActive: false name: BSM Exception Testing weightReducedBy: 0 includeInBaggageCount: false - baggageTypeCode: MUSIC bagWeightType: 1 freeBag: false inActive: false name: Musical Equipment weightReducedBy: 5 includeInBaggageCount: false - baggageTypeCode: BSME bagWeightType: 0 freeBag: true inActive: false name: OPS Baggage - DO NOT EDIT weightReducedBy: 0 includeInBaggageCount: false - baggageTypeCode: MEDIC bagWeightType: 0 freeBag: true inActive: false name: Medical Equipment weightReducedBy: 0 includeInBaggageCount: false /api/nsk/v1/resources/BaggageTypes/{baggageTypeCode}: get: tags: - resources summary: Retrieves the specific baggage type resource. description: 'GraphQL endpoint: resourceBaggageType' operationId: nsk_v1_resources_BaggageTypes_baggageTypeCode_get parameters: - name: baggageTypeCode in: path required: true description: The unique baggage type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfBaggageType' /api/nsk/v1/resources/bundles: get: tags: - resources summary: Retrieves the collection of bundle configuration resources. description: 'GraphQL endpoint: bundles' operationId: nsk_v1_resources_bundles_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleConfiguration' examples: Retrieve the collection of bundle configuration resources: description: Example response for successfully retrieving the collection of bundle configuration resources. value: data: - bundleCode: CC02 feeCode: CCBF bookingQueueCode: CALLC programCode: CC programLevel: Plus name: Call Center Application Plus description: '[All legs - Fixed pricing] 10kg checked-in baggage The healthy choice snack > Hot Meal Combo' hasPrice: true rank: 2 inActive: false allSsrsRequired: false serviceBundleType: 1 - bundleCode: BSC feeCode: null bookingQueueCode: NFSVCF programCode: null programLevel: null name: Basics Included Bundle description: Basic Included Bundle - SSR hasPrice: false rank: 1 inActive: false allSsrsRequired: false serviceBundleType: 0 - bundleCode: CC14 feeCode: CCBF bookingQueueCode: null programCode: null programLevel: null name: Call Center Application Business description: '[No Upgrades / All legs] 30kg of baggage Hot Meal Combo *WIFI' hasPrice: true rank: 4 inActive: true allSsrsRequired: true serviceBundleType: 1 /api/nsk/v1/resources/bundles/{bundleCode}: get: tags: - resources summary: Retrieves a specific bundle configuration based on the bundle code. description: 'GraphQL endpoint: bundle' operationId: nsk_v1_resources_bundles_bundleCode_get parameters: - name: bundleCode in: path required: true description: The bundle code. schema: type: string x-position: 1 - name: cultureCode in: query description: The culture code. schema: type: - string - 'null' x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfBundleConfiguration' examples: Get Bundle By Bundle Code Response: description: Example response for successfully retrieving a bundle by bundle code value: data: bundleCode: CC02 feeCode: CCBF bookingQueueCode: CALLC programCode: CC programLevel: Plus name: Call Center Application Plus description: '[All legs - Fixed pricing] 10kg checked-in baggage The healthy choice snack > Hot Meal Combo' hasPrice: true rank: 2 inActive: false allSsrsRequired: false serviceBundleType: 1 /api/nsk/v1/resources/bundles/applications: get: tags: - resources summary: Retrieves the collection of bundle application resources. description: 'See api/nsk/v1/bundles/application/{bundleApplicationKey}/details to retrieve additional bundle application details. The application details consist of three lists: carrier codes, product classes, and classes of service. GraphQL endpoint: bundleApplications' operationId: nsk_v1_resources_bundles_applications_get parameters: - name: BundleRuleCode in: query description: "The bundle rule code.\n " schema: type: - string - 'null' maxLength: 4 minLength: 0 x-position: 1 - name: CultureCode in: query description: "The specific culture code.\n " schema: type: - string - 'null' x-position: 2 - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleApplication' /api/nsk/v1/resources/bundles/rules: get: tags: - resources summary: Retrieves the collection of bundle rule resources. description: 'See api/nsk/v1/bundles/rule/{bundleRuleCode}/details to retrieve a list of bundle applications associated with a specific bundle rule. Bundle rules are used to control where and how bundle applications are used. GraphQL endpoint: bundleRules' operationId: nsk_v1_resources_bundles_rules_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleRule' /api/nsk/v1/resources/bundles/sets: get: tags: - resources summary: Retrieves the collection of bundle set resources. description: 'See api/nsk/v1/bundles/set/{bundleSetCode}/details to retrieve a list of bundle codes associated with a specific bundle set. GraphQL endpoint: bundleSets' operationId: nsk_v1_resources_bundles_sets_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleSet' /api/nsk/v1/resources/bundles/ssrs: get: tags: - resources summary: 'Retrieves the collection of bundle ssr configurations associated with the bundle code.' description: 'GraphQL endpoint: bundleSsrs' operationId: nsk_v1_resources_bundles_ssrs_get parameters: - name: BundleCode in: query description: "The bundle code.\n " schema: type: - string - 'null' maxLength: 4 minLength: 0 x-position: 1 - name: CultureCode in: query description: "The specific culture code.\n " schema: type: - string - 'null' x-position: 2 - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfBundleSsrConfiguration' /api/nsk/v1/resources/carriers: get: tags: - resources summary: Retrieves the collection of carrier resources. description: 'GraphQL endpoint: resourceCarriers' operationId: nsk_v1_resources_carriers_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCarrier' /api/nsk/v1/resources/carriers/{carrierCode}: get: tags: - resources summary: Retrieves a single carrier. description: 'GraphQL endpoint: resourceCarrierv2' operationId: nsk_v1_resources_carriers_carrierCode_get parameters: - name: carrierCode in: path required: true description: The unique carrier code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - 'null' x-position: 2 - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCarrier' /api/nsk/v1/resources/Cities: get: tags: - resources summary: Retrieves the collection of city resources. description: 'GraphQL endpoint: resourceCities' operationId: nsk_v1_resources_Cities_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCity' /api/nsk/v1/resources/Cities/{cityCode}: get: tags: - resources summary: Retrieves the specific city resource. description: 'GraphQL endpoint: resourceCity' operationId: nsk_v1_resources_Cities_cityCode_get parameters: - name: cityCode in: path required: true description: The unique city code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfCity' /api/nsk/v1/resources/ClassOfServices: get: tags: - resources summary: Retrieves the collection of class of service resources. description: 'GraphQL endpoint: resourceClassOfServices' operationId: nsk_v1_resources_ClassOfServices_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfClassOfService' /api/nsk/v1/resources/ClassOfServices/{classOfServiceCode}: get: tags: - resources summary: Retrieves the resource. description: 'GraphQL endpoint: resourceClassOfService' operationId: nsk_v1_resources_ClassOfServices_classOfServiceCode_get parameters: - name: classOfServiceCode in: path required: true description: The unique class of service code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfClassOfService' /api/nsk/v1/resources/CommissionRates: get: tags: - resources summary: Retrieves the collection of commission rate resources. description: 'GraphQL endpoint: resourceCommissionRates' operationId: nsk_v1_resources_CommissionRates_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCommissionRate' /api/nsk/v1/resources/CommissionRates/{commissionRateCode}: get: tags: - resources summary: Retrieves the specific commission rate resource. description: 'GraphQL endpoint: resourceCommissionRate' operationId: nsk_v1_resources_CommissionRates_commissionRateCode_get parameters: - name: commissionRateCode in: path required: true description: The unique commission rate code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfCommissionRate' /api/nsk/v1/resources/ContactTypes: get: tags: - resources summary: Retrieves the collection of contact type resources. description: 'GraphQL endpoint: resourceContactTypes' operationId: nsk_v1_resources_ContactTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfContactType' /api/nsk/v1/resources/ContactTypes/{contactTypeCode}: get: tags: - resources summary: Retrieves the specific contact type resource. description: 'GraphQL endpoint: resourceContactType' operationId: nsk_v1_resources_ContactTypes_contactTypeCode_get parameters: - name: contactTypeCode in: path required: true description: The unique contact type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfContactType' /api/nsk/v1/resources/contents: get: tags: - resources summary: Searches the contents based on the search criteria provided. description: Searches the contents based on the search criteria provided. operationId: nsk_v1_resources_contents_get parameters: - name: Name in: query description: "Name of the content.\n " schema: type: - string - 'null' x-position: 1 - name: Type in: query description: "Specific content type.\n \nEnumeration values: 0 = GeneralReference, 1 = News, 2 = ConsoleHelp, 3 = FareRuleReference, 4 = ReviewWithCustomer, 8 = Image, 9 = PromotionReference, 10 = SubscriptionReference" schema: $ref: '#/components/schemas/ContentType' x-position: 2 - name: ContainerId in: query description: "Unique id of the container.\n " schema: type: - integer - 'null' format: int64 x-position: 3 - name: PageSize in: query description: "The default page size.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 - name: LastContentId in: query description: "Used to specify the last item of the page of the last set of records retrieved\nwhen paging was performed. This is optional.\n " schema: type: - integer - 'null' format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 x-position: 5 responses: '200': description: Search content succeeded. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIEnumerableOfResourceContentResult' /api/nsk/v1/resources/contents/{contentId}: get: tags: - resources summary: Retrieves a resource setting and its related information. description: 'This is a post to easily allow special path characters. See /resources/settings/data to avoid manually parsing the data.' operationId: nsk_v1_resources_contents_contentId_get parameters: - name: contentId in: path required: true description: The content id. schema: type: integer format: int64 x-position: 1 - name: convertRtfToHtml in: query description: The bool to determine whether or not to convert RTF to HTML data. schema: type: - boolean - 'null' x-position: 2 - name: eTag in: query description: ETag for caching. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfResourceContentItem' delete: tags: - resources summary: Deletes a content item. description: 'This endpoint currently only supports deleting news content items. Deletion of other content types will be supported in the future. GraphQL endpoint: resourceContentDeletev2' operationId: nsk_v1_resources_contents_contentId_delete parameters: - name: contentId in: path required: true description: The content identifier. schema: type: integer format: int64 x-position: 1 responses: '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Deleting content is not allowed: description: Example when deleting content is not allowed. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:Content:DeleteContentNotAllowed message: nsk:Content:DeleteContentNotAllowed type: Validation details: null rawMessage: Deleting content is not allowed. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Deleting news is not allowed: description: Example when deleting news is not allowed. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:Content:DeleteNewsNotAllowed message: nsk:Content:DeleteNewsNotAllowed type: Validation details: null rawMessage: Deleting news is not allowed. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Content does not exist: description: Example when the content does not exist. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:Content:ContentDoesNotExist message: nsk:Content:ContentDoesNotExist type: Validation details: null rawMessage: The content does not exist. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Deleting non-news content: description: Example when the content is not a news. Non-news content deletion is currently not supported. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: nsk:Content:DeleteNonNewsContentNotSupported message: nsk:Content:DeleteNonNewsContentNotSupported type: Validation details: null rawMessage: Deleting non-news content is currently not supported. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Content ID is null.: description: Example when the content ID is null. It can be set to null by setting it to a URL encoded space value `%20` or to a value that cannot be converted to type `long`. value: errors: - id: ebaf3f43-1fd2-7c9b-5f3c-1d0778e52701 code: core:Validation:NullRequest message: The request is null or couldn't be converted to the expected data type. type: Error details: null rawMessage: The request is null or couldn't be converted to the expected data type. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Content deleted successfully: description: Example when the content deleted successfully. value: data: null /api/nsk/v1/resources/contents/{contentId}/data: get: tags: - resources summary: Retrieves resource setting data based on the accept content type. description: 'This is a post to easily allow special path characters. If the data returned is not in HTML format and convertRtfToHtml is set to true, the content requested was of an incompatible data type.' operationId: nsk_v1_resources_contents_contentId_data_get parameters: - name: contentId in: path required: true description: The content id. schema: type: integer format: int64 x-position: 1 - name: convertRtfToHtml in: query description: The bool to determine whether or not to convert RTF to HTML data. schema: type: - boolean - 'null' x-position: 2 - name: eTag in: query description: ETag for caching. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: type: string format: byte /api/nsk/v2/resources/countries: get: tags: - resources summary: Retrieves the collection of country resources. description: 'GraphQL endpoint: resourceCountriesv2' operationId: nsk_v2_resources_countries_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCountryv2' /api/nsk/v2/resources/countries/{countryCode}: get: tags: - resources summary: Retrieves a specific country resource. description: 'GraphQL endpoint: resourceCountryv2' operationId: nsk_v2_resources_countries_countryCode_get parameters: - name: countryCode in: path required: true description: The unique country code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfCountryv2' /api/nsk/v1/resources/cultures: get: tags: - resources summary: Retrieves the resources. description: 'GraphQL endpoint: resourceCultures' operationId: nsk_v1_resources_cultures_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCulture' /api/nsk/v1/resources/cultures/{cultureCode}: get: tags: - resources summary: Retrieves the resource. description: 'GraphQL endpoint: resourceCulture' operationId: nsk_v1_resources_cultures_cultureCode_get parameters: - name: cultureCode in: path required: true description: The unique culture code. schema: type: string x-position: 1 - name: forCultureCode in: query description: The for culture. schema: type: - string - '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/IJsonResponseOfCulture' /api/nsk/v2/resources/currencies: get: tags: - resources summary: Retrieves the collection of currency resources. description: 'GraphQL endpoint: resourceCurrenciesv2' operationId: nsk_v2_resources_currencies_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCurrencyv2' /api/nsk/v2/resources/currencies/{currencyCode}: get: tags: - resources summary: Retrieves the specific currency resource. description: 'GraphQL endpoint: resourceCurrencyv2' operationId: nsk_v2_resources_currencies_currencyCode_get parameters: - name: currencyCode in: path required: true description: The unique currency code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfCurrencyv2' /api/nsk/v2/resources/customerPrograms: get: tags: - resources summary: Retrieves the collection of customer program resources. description: 'GraphQL endpoint: resourceCustomerProgramsv2' operationId: nsk_v2_resources_customerPrograms_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCustomerProgramv2' examples: Retrieve Customer Programs v2 Response: description: Example response for successfully retrieving the customer programs v2 resources value: data: programCode: ABC name: ABC Customer Program programType: 1 inActive: false customerProgramLevels: - programCode: ABC programLevelCode: LV1 name: ABC Level 1 shortName: ABC Level 1 displayCode: '1' rank: 1 inActive: false customerProgramSettings: - programCode: NV programLevel: NV1 settingCode: BoardingZone sequenceNumber: 1 settingValue: '1' checkDigitType: 1 /api/nsk/v1/resources/CustomerPrograms: get: tags: - resources summary: Retrieves the collection of customer program resources. description: 'GraphQL endpoint: resourceCustomerPrograms' operationId: nsk_v1_resources_CustomerPrograms_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfCustomerProgram' deprecated: true /api/nsk/v2/resources/customerPrograms/{programCode}: get: tags: - resources summary: Retrieves the specific customer program resource. description: 'GraphQL endpoint: resourceCustomerProgramv2' operationId: nsk_v2_resources_customerPrograms_programCode_get parameters: - name: programCode in: path required: true description: The unique program code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfCustomerProgramv2' examples: Retrieve Customer Programs v2 Response: description: Example response for successfully retrieving the customer programs v2 resources value: data: programCode: ABC name: ABC Customer Program programType: 1 inActive: false customerProgramLevels: - programCode: ABC programLevelCode: LV1 name: ABC Level 1 shortName: ABC Level 1 displayCode: '1' rank: 1 inActive: false customerProgramSettings: - programCode: NV programLevel: NV1 settingCode: BoardingZone sequenceNumber: 1 settingValue: '1' checkDigitType: 1 /api/nsk/v1/resources/CustomerPrograms/{programCode}: get: tags: - resources summary: Retrieves the specific customer program resource. description: 'GraphQL endpoint: resourceCustomerProgram' operationId: nsk_v1_resources_CustomerPrograms_programCode_get parameters: - name: programCode in: path required: true description: The unique program code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfCustomerProgram' deprecated: true /api/nsk/v1/resources/CustomerPrograms/{programCode}/levels/{programLevelCode}: get: tags: - resources summary: Retrieves the specific program level. description: Retrieves the specific program level. operationId: nsk_v1_resources_CustomerPrograms_programCode_levels_programLevelCode_get parameters: - name: programCode in: path required: true description: The unique program code. schema: type: string x-position: 1 - name: programLevelCode in: path required: true description: The unique program level code. schema: type: string x-position: 2 - name: cultureCode in: query description: The culture code. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfCustomerProgramLevel' /api/nsk/v1/resources/Delays: get: tags: - resources summary: Retrieves the collection of delay resources. description: 'GraphQL endpoint: resourceDelays' operationId: nsk_v1_resources_Delays_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfDelay' /api/nsk/v1/resources/Delays/{delayCode}: get: tags: - resources summary: Retrieves the specific delay resource. description: 'GraphQL endpoint: resourceDelay' operationId: nsk_v1_resources_Delays_delayCode_get parameters: - name: delayCode in: path required: true description: The unique delay code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfDelay' /api/nsk/v1/resources/Departments: get: tags: - resources summary: Retrieves the collection of department resources. description: 'GraphQL endpoint: resourceDepartments' operationId: nsk_v1_resources_Departments_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfDepartment' /api/nsk/v1/resources/Departments/{departmentCode}: get: tags: - resources summary: Retrieves the specific department resource. description: 'GraphQL endpoint: resourceDepartment' operationId: nsk_v1_resources_Departments_departmentCode_get parameters: - name: departmentCode in: path required: true description: The unique department code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfDepartment' /api/nsk/v1/resources/distributionOptions: get: tags: - resources summary: Retrieves the localizations. description: 'GraphQL endpoint: localizationDistributionOptions' operationId: nsk_v1_resources_distributionOptions_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEnumResource' /api/nsk/v1/resources/DocumentTypes: get: tags: - resources summary: Retrieves the collection of document type resources. description: 'GraphQL endpoint: resourceDocumentTypes' operationId: nsk_v1_resources_DocumentTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfDocumentType' /api/nsk/v1/resources/DocumentTypes/{documentTypeCode}: get: tags: - resources summary: Retrieves the specific document type resource. description: 'GraphQL endpoint: resourceDocumentType' operationId: nsk_v1_resources_DocumentTypes_documentTypeCode_get parameters: - name: documentTypeCode in: path required: true description: The unique document type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfDocumentType' /api/nsk/v1/resources/Domains: get: tags: - resources summary: Retrieves the collection of domain resources. description: 'GraphQL endpoint: resourceDomains' operationId: nsk_v1_resources_Domains_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Domains not found: description: Response when there are no existing domains. value: data: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Matching ETag: description: Response when an ETag is provided and the cached data still matches. value: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfDomain' examples: Retrieve domains response: description: Example response for successfully retrieving the configured domains in the system. value: data: - domainCode: DEF name: Default Domain passwordNeverExpires: true minimumPasswordAge: 15 maximumPasswordAge: 90 maximumFaliedLogons: 3 uniquePasswordCount: null passwordPolicy: policy: ^(?=.*\d)(?=.*[a-z])(?=.*[A-Z])(?!.*[\.,~])(?=.*\W).{8,16}$ description: Password must be at least 8 characters, no more than 16 characters, must include at least one upper case letter, one lower case letter, one numeric digit, and one non-alphanumeric. The password cannot contain a period(.) comma(,) or tilde(~). usernamePolicy: policy: ^(?!.*[\.,~]).{2,64}$ description: Username must be at least 2 characters, no more than 64 characters. The username cannot contain a period(.) comma(,) or tilde(~). allowed: true useNewResetPasswordFlow: true challengeCodeContactMethod: 1 maximumFailedPasswordResets: 6 challengeCodeExpirationMinutes: 15 failedPasswordResetMinutes: 30 - domainCode: EXT name: External Domain passwordNeverExpires: true minimumPasswordAge: 15 maximumPasswordAge: 90 maximumFaliedLogons: 3 uniquePasswordCount: 5 passwordPolicy: policy: ^(?=.*\\d)(?=.*[a-z])(?=.*[A-Z])(?!.*[\\.,~])(?=.*\\W).{8,16}$ description: Password must be at least 8 characters, no more than 16 characters, must include at least one upper case letter, one lower case letter, one numeric digit, and one non-alphanumeric. The password cannot contain a period(.) comma(,) or tilde(~). usernamePolicy: policy: ^.*$ description: Username must be at least 2 characters, no more than 64 characters. The username cannot contain a period(.) comma(,) or tilde(~). allowed: true useNewResetPasswordFlow: false challengeCodeContactMethod: 0 maximumFailedPasswordResets: 6 challengeCodeExpirationMinutes: 15 failedPasswordResetMinutes: 30 /api/nsk/v1/resources/Domains/{domainCode}: get: tags: - resources summary: Retrieves the specific domain resource. description: 'GraphQL endpoint: resourceDomain' operationId: nsk_v1_resources_Domains_domainCode_get parameters: - name: domainCode in: path required: true description: The unique domain code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Domain not found: description: Response when the specified domain does not exist. value: data: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfDomain' examples: Retrieve domain response: description: Example response for successfully retrieving a specified configured domain in the system. value: data: domainCode: DEF name: Default Domain passwordNeverExpires: true minimumPasswordAge: 15 maximumPasswordAge: 90 maximumFaliedLogons: 3 uniquePasswordCount: null passwordPolicy: policy: ^(?=.*\d)(?=.*[a-z])(?=.*[A-Z])(?!.*[\.,~])(?=.*\W).{8,16}$ description: Password must be at least 8 characters, no more than 16 characters, must include at least one upper case letter, one lower case letter, one numeric digit, and one non-alphanumeric. The password cannot contain a period(.) comma(,) or tilde(~). usernamePolicy: policy: ^(?!.*[\.,~]).{2,64}$ description: Username must be at least 2 characters, no more than 64 characters. The username cannot contain a period(.) comma(,) or tilde(~). allowed: true useNewResetPasswordFlow: true challengeCodeContactMethod: 1 maximumFailedPasswordResets: 6 challengeCodeExpirationMinutes: 15 failedPasswordResetMinutes: 30 /api/nsk/v1/resources/EmailTypes: get: tags: - resources summary: Retrieves the collection of email type resources. description: 'GraphQL endpoint: resourceEmailTypes' operationId: nsk_v1_resources_EmailTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEmailType' /api/nsk/v1/resources/EmailTypes/{emailTypeCode}: get: tags: - resources summary: Retrieves the specific email type resource. description: 'GraphQL endpoint: resourceEmailType' operationId: nsk_v1_resources_EmailTypes_emailTypeCode_get parameters: - name: emailTypeCode in: path required: true description: The unique email type code. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfEmailType' /api/nsk/v1/resources/ExternalRates: get: tags: - resources summary: Retrieves the collection of external rate resources. description: 'The external rates cache expiration is configurable as a number of minutes past the hour to expire. This should allow for better alignment with third party external rates providers'' recommendations, which typically state that external rates cache items should expire 5-7 minutes past the hour. This can be configured in the NskSystemOptions.ExternalRatesExpiration. If no value is set, the API will default to five minutes past the hour. If the value "Enable External Currency Conversion" is disabled in SkyPay, external rates won''t be returned by this call. Additionally, there are some edge cases where the cache entry expiration is created at or close to the configured expiration time. In these cases, an additional two minutes will be added to the cache expiration. For example, if the configured external rate cache expiration is for five minutes after the hour, and the current time is 12:04, the expiration will be 12:07 instead of 12:05. This gives the cached item enough time to get set into cache, but will expire quickly in order to refresh according to third party external rates providers'' cache requirements (refresh at 5-7 minutes past the hour). GraphQL endpoint: resourceExternalRates' operationId: nsk_v1_resources_ExternalRates_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfExternalRate' /api/nsk/v1/resources/ExternalRates/{rateId}: get: tags: - resources summary: Retrieves the specific external rate resource. description: 'The external rates cache expiration is configurable as a number of minutes past the hour to expire. This should allow for better alignment with third party external rates providers'' recommendations, which typically state that external rates cache items should expire 5-7 minutes past the hour. This can be configured in the NskSystemOptions.ExternalRatesExpiration. If no value is set, the API will default to five minutes past the hour. If the value "Enable External Currency Conversion" is disabled in SkyPay, external rates won''t be returned by this call. GraphQL endpoint: resourceExternalRate' operationId: nsk_v1_resources_ExternalRates_rateId_get parameters: - name: rateId in: path required: true description: The unique rate ID. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfExternalRate' /api/nsk/v1/resources/ExternalSystems: get: tags: - resources summary: Retrieves the collection of external system resources. description: 'GraphQL endpoint: resourceExternalSystems' operationId: nsk_v1_resources_ExternalSystems_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfExternalSystem' /api/nsk/v2/resources/externalSystems/{systemCode}: get: tags: - resources summary: Retrieves a single external system resource. description: 'GraphQL endpoint: resourceExternalSystemv2' operationId: nsk_v2_resources_externalSystems_systemCode_get parameters: - name: systemCode in: path required: true description: The unique external system code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfExternalSystem' /api/nsk/v1/resources/fareBasisCodes: get: tags: - resources summary: Retrieves the list of fare basis codes. description: 'GraphQL endpoint: resourceFareBasisCodes' operationId: nsk_v1_resources_fareBasisCodes_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfString' examples: Fare basis response: description: Gets the list of fare basis codes value: - A - A0807 - A2FARE - AAAAFARE /api/nsk/v1/resources/fareDiscounts: get: tags: - resources summary: Retrieves a collection of fare discount resources. description: 'GraphQL endpoint: resourceFareDiscounts' operationId: nsk_v1_resources_fareDiscounts_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareDiscount' /api/nsk/v1/resources/fareDiscounts/{fareDiscountCode}: get: tags: - resources summary: Retrieves a specific fare discount resource. description: 'GraphQL endpoint: resourceFareDiscount' operationId: nsk_v1_resources_fareDiscounts_fareDiscountCode_get parameters: - name: fareDiscountCode in: path required: true description: The unique fare discount code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfFareDiscount' /api/nsk/v1/resources/fareSurcharges: get: tags: - resources summary: Retrieves a collection of fare surcharge resources. description: 'GraphQL endpoint: resourceFareSurcharges' operationId: nsk_v1_resources_fareSurcharges_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareSurcharge' /api/nsk/v1/resources/fareSurcharges/{fareSurchargeCode}: get: tags: - resources summary: Retrieves a specific fare surcharge resource. description: 'GraphQL endpoint: resourceFareSurcharge' operationId: nsk_v1_resources_fareSurcharges_fareSurchargeCode_get parameters: - name: fareSurchargeCode in: path required: true description: The unique fare surcharge code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfFareSurcharge' /api/nsk/v1/resources/FareTypes: get: tags: - resources summary: Retrieves the collection of fare type resources. description: 'GraphQL endpoint: resourceFareTypes' operationId: nsk_v1_resources_FareTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFareType' /api/nsk/v1/resources/FareTypes/{fareTypeCode}: get: tags: - resources summary: Retrieves the specific fare type resource. description: 'GraphQL endpoint: resourceFareType' operationId: nsk_v1_resources_FareTypes_fareTypeCode_get parameters: - name: fareTypeCode in: path required: true description: The unique fare type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfFareType' /api/nsk/v1/resources/Fees: get: tags: - resources summary: Retrieves the collection of fee resources. description: 'GraphQL endpoint: resourceFees' operationId: nsk_v1_resources_Fees_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFee' /api/nsk/v1/resources/Fees/{feeCode}: get: tags: - resources summary: Retrieves the specific fee resource. description: 'GraphQL endpoint: resourceFee' operationId: nsk_v1_resources_Fees_feeCode_get parameters: - name: feeCode in: path required: true description: The unique fee code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfFee' /api/nsk/v1/resources/fees/{feeCode}/details: get: tags: - resources summary: Gets the fee options. description: 'Note, this endpoint is not cached like other resource endpoints. The NSK enumeration "TSI.GroundTimeBeforeDepartureFromConnectionWithin" is synonymous with "TravelSegmentIndicator.DepartureWithinStopoverTime". The NSK enumeration "TSI.GroundTimeBeforeDepartureFromConnectionExceeds" is synonymous with "TravelSegmentIndicator.DepartureExceedsStopoverTime". GraphQL endpoint: feeDetails' operationId: nsk_v1_resources_fees_feeCode_details_get parameters: - name: feeCode in: path required: true description: The unique fee code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfFeeDetail' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/resources/genders: get: tags: - resources summary: Retrieves the localizations. description: 'GraphQL endpoint: localizationGender' operationId: nsk_v1_resources_genders_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEnumResource' /api/nsk/v1/resources/HotCardReasons: get: tags: - resources summary: Retrieves the collection of hot card reason resources. description: 'GraphQL endpoint: resourceHotCardReasons' operationId: nsk_v1_resources_HotCardReasons_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfHotCardReason' /api/nsk/v1/resources/HotCardReasons/{hotCardReasonCode}: get: tags: - resources summary: Retrieves the specific hot card reason resource. description: 'GraphQL endpoint: resourceHotCardReason' operationId: nsk_v1_resources_HotCardReasons_hotCardReasonCode_get parameters: - name: hotCardReasonCode in: path required: true description: The unique hot card reason. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfHotCardReason' /api/nsk/v1/resources/IssuanceReasons: get: tags: - resources summary: Retrieves the collection of issuance reason resources. description: 'GraphQL endpoint: resourceIssuanceReasons' operationId: nsk_v1_resources_IssuanceReasons_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfIssuanceReason' /api/nsk/v1/resources/IssuanceReasons/{issuanceReasonCode}: get: tags: - resources summary: Retrieves the specific issuance reason resource. description: 'GraphQL endpoint: resourceIssuanceReason' operationId: nsk_v1_resources_IssuanceReasons_issuanceReasonCode_get parameters: - name: issuanceReasonCode in: path required: true description: The unique issuance reason code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfIssuanceReason' /api/nsk/v1/resources/Locations: get: tags: - resources summary: Retrieves the collection of location resources. description: 'GraphQL endpoint: resourceLocations' operationId: nsk_v1_resources_Locations_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfLocation' /api/nsk/v1/resources/Locations/{locationCode}: get: tags: - resources summary: Retrieves the specific location resource. description: 'GraphQL endpoint: resourceLocation' operationId: nsk_v1_resources_Locations_locationCode_get parameters: - name: locationCode in: path required: true description: The code for the desired location resource. schema: type: string x-position: 1 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: - string - '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/IJsonResponseOfLocation' /api/nsk/v2/resources/macs: get: tags: - resources summary: Retrieves the collection of mac resources. description: 'GraphQL endpoint: resourceMacsv2' operationId: nsk_v2_resources_macs_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfMac' /api/nsk/v1/resources/Macs/{macCode}: get: tags: - resources summary: Retrieves the specific mac resource. description: 'GraphQL endpoint: resourceMac' operationId: nsk_v1_resources_Macs_macCode_get parameters: - name: macCode in: path required: true description: The unique mac code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMac' /api/nsk/v1/resources/marketRoutes: get: tags: - resources summary: Retrieves the collection of market route resources. description: 'GraphQL endpoint: resourceMarketRoutes' operationId: nsk_v1_resources_marketRoutes_get parameters: - name: DepartureStation in: query description: "Gets or sets the departure station for this request.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 1 - name: ArrivalStation in: query description: "Gets or sets the arrival station for this request.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache eTag for this request.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Matching ETag: description: Response when an ETag is provided and the cached data still matches. No Market Routes are returned regardless of the station filters specified. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Invalid Departure Station Length Error: description: Example error when departure station is an incorrect length. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: MarketRoutesQuery.DepartureStation:StringLengthAttribute message: MarketRoutesQuery.DepartureStation:StringLengthAttribute type: Validation details: validation: StringLengthAttribute model: MarketRoutesQuery member: DepartureStation rawMessage: The field MarketRoutesQuery must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null Invalid Arrival Station Length Error: description: Example error when arrival station is an incorrect length. value: errors: - id: 2f5dd7f3-47f7-48fb-a180-f9152278605f code: MarketRoutesQuery.ArrivalStation:StringLengthAttribute message: MarketRoutesQuery.ArrivalStation:StringLengthAttribute type: Validation details: validation: StringLengthAttribute model: MarketRoutesQuery member: ArrivalStation rawMessage: The field MarketRoutesQuery must be a string with a maximum length of 3. exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfMarketRoute' examples: Default without DepartureStation or ArrivalStation filters: description: Response when neither DepartureStation or ArrivalStation are specified. All Market Routes are returned. value: data: - arrivalStation: BOS departureStation: ATL connectionMarketSegments: - departureStation: ATL arrivalStation: BOS segmentNumber: 1 - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: ATL segmentNumber: 2 - departureStation: ATL arrivalStation: JFK segmentNumber: 3 - arrivalStation: JFK departureStation: DEN connectionMarketSegments: - departureStation: DEN arrivalStation: JFK segmentNumber: 1 - arrivalStation: BOS departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: BOS segmentNumber: 2 - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: JFK segmentNumber: 2 DepartureStation filter specified: description: Response when DepartureStation filter specified but not ArrivalStation. Market Routes with the specified DepartureStation are returned. value: data: - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: ATL segmentNumber: 2 - departureStation: ATL arrivalStation: JFK segmentNumber: 3 - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: JFK segmentNumber: 2 ArrivalStation filter specified: description: Response when ArrivalStation filter specified but not DepartureStation. Market Routes with the specified ArrivalStation are returned. value: data: - arrivalStation: BOS departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: BOS segmentNumber: 2 - arrivalStation: BOS departureStation: ATL connectionMarketSegments: - departureStation: ATL arrivalStation: BOS segmentNumber: 1 DepartureStation and ArrivalStation filters specified: description: Response when both DepartureStation and ArrivalStation filters are specified. Only Market Routes with the specified DepartureStation and ArrivalStation are returned. value: data: - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: ATL segmentNumber: 2 - departureStation: ATL arrivalStation: JFK segmentNumber: 3 - arrivalStation: JFK departureStation: SLC connectionMarketSegments: - departureStation: SLC arrivalStation: DEN segmentNumber: 1 - departureStation: DEN arrivalStation: JFK segmentNumber: 2 /api/nsk/v2/resources/markets: get: tags: - resources summary: Retrieves the collection of market resources. description: 'GraphQL endpoint: resourceMarketsv2' operationId: nsk_v2_resources_markets_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfMarketv2' /api/nsk/v2/resources/markets/{locationCode}: get: tags: - resources summary: Retrieves a specific market resource. description: 'GraphQL endpoint: resourceMarketByLocationv2' operationId: nsk_v2_resources_markets_locationCode_get parameters: - name: locationCode in: path required: true description: The unique location code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfListOfMarketv2' /api/nsk/v2/resources/markets/{locationCode}/{travelLocationCode}: get: tags: - resources summary: Retrieves the resource. description: 'GraphQL endpoint: resourceMarketv2' operationId: nsk_v2_resources_markets_locationCode_travelLocationCode_get parameters: - name: locationCode in: path required: true description: The code for the desired location resource. schema: type: string x-position: 1 - name: travelLocationCode in: path required: true description: The code for the desired travel location resource. schema: type: string x-position: 2 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfMarketv2' /api/nsk/v1/resources/MessageTypes: get: tags: - resources summary: Retrieves the collection of message type resources. description: 'GraphQL endpoint: resourceMessageTypes' operationId: nsk_v1_resources_MessageTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfMessageType' /api/nsk/v1/resources/MessageTypes/{messageTypeCode}: get: tags: - resources summary: Retrieves the specific message type resource. description: 'GraphQL endpoint: resourceMessageType' operationId: nsk_v1_resources_MessageTypes_messageTypeCode_get parameters: - name: messageTypeCode in: path required: true description: The unique message type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfMessageType' /api/nsk/v1/resources/nonBinaryGenders: get: tags: - resources summary: Retrieves the collection of non-binary genders configured in the system. description: 'If the `Enable Gender Neutral` settings is unchecked, only the `M (Male)` and `F (Female)` are considered as valid non-binary genders for passengers. GraphQL endpoint: resourceNonBinaryGenders' operationId: nsk_v1_resources_nonBinaryGenders_get parameters: - name: cultureCode in: query description: The specific culture code. schema: type: - string - 'null' x-position: 1 - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNonBinaryGender' examples: Retrieve non-binary genders response: description: Example response for successfully retrieving the configured non-binary genders in the system. value: data: - code: F name: Female inActive: false - code: M name: Male inActive: false - code: U name: Undisclosed inActive: false - code: X name: Unspecified inActive: false /api/nsk/v1/resources/nonBinaryGenders/{code}: get: tags: - resources summary: Retrieves the specified non-binary gender. description: 'GraphQL endpoint: resourceNonBinaryGender' operationId: nsk_v1_resources_nonBinaryGenders_code_get parameters: - name: code in: path required: true description: The unique non-binary gender code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - 'null' x-position: 2 - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfNonBinaryGender' /api/nsk/v1/resources/organizationStatuses: get: tags: - resources summary: Retrieves the localizations. description: 'GraphQL endpoint: localizationOrganizationStatus' operationId: nsk_v1_resources_organizationStatuses_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEnumResource' /api/nsk/v1/resources/PassengerDiscounts: get: tags: - resources summary: Retrieves the collection of passenger discount resources. description: 'GraphQL endpoint: resourcePassengerDiscounts' operationId: nsk_v1_resources_PassengerDiscounts_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerDiscount' /api/nsk/v1/resources/PassengerDiscounts/{passengerDiscountCode}: get: tags: - resources summary: Retrieves the specific passenger discount resource. description: 'GraphQL endpoint: resourcePassengerDiscount' operationId: nsk_v1_resources_PassengerDiscounts_passengerDiscountCode_get parameters: - name: passengerDiscountCode in: path required: true description: The unique passenger discount code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfPassengerDiscount' /api/nsk/v1/resources/PassengerTypes: get: tags: - resources summary: Retrieves the collection of role-based passenger type resources. description: 'GraphQL endpoint: resourcePassengerTypes' operationId: nsk_v1_resources_PassengerTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Culture Code Not Configured: description: The provided culture code in the request is not configured in the resources. For valid culture codes, see GET /api/nsk/v1/resources/cultures value: errors: - id: null code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''asdf'' is out of range for ''ResourceQueryBase.CultureCode''.\nExpected values: (en-US,ar-AE,ar-BH,ar-IQ,ar-KW,ar-QA,ar-SA,ar-SY,ca-ES,de-CH,de-DE,de-LI,en-AU,en-CA,en-GB,en-IE,en-NZ,en-PH,en-TT,en-ZA,en-ZW,es-ES,es-GT,es-MX,fr-CA,fr-FR,hi-IN,hu-HU,id-ID,it-IT,ja-JP,ko-KR,ms,ms-MY,nb-NO,pt-BR,ru-RU,sw,sw-KE,th-TH,vi-VN,zh-CN,zh-SG,zh-TW)' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPassengerType' examples: Retrieve Passenger Types Response: description: Example response for successfully retrieving the passenger types in the system. value: data: - nonAdult: false passengerTypeCode: ADT name: Adult allowed: true inActive: false typeIndicator: 0 minimumAge: 18 maximumAge: 65 - nonAdult: false passengerTypeCode: SNR name: Senior allowed: true inActive: false typeIndicator: 0 minimumAge: 60 maximumAge: 150 Passenger Types Not Found: description: Example response when there are no existing passenger types. value: data: [] /api/nsk/v1/resources/PassengerTypes/{passengerTypeCode}: get: tags: - resources summary: Retrieves the specific role-based passenger type resource. description: 'GraphQL endpoint: resourcePassengerType' operationId: nsk_v1_resources_PassengerTypes_passengerTypeCode_get parameters: - name: passengerTypeCode in: path required: true description: The unique passenger type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - 'null' x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Passenger Type Not Found: description: Example response when the specified passenger type does not exist. value: data: null '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' examples: Culture Code Not Configured: description: The provided culture code in the request is not configured in the resources. For valid culture codes, see GET /api/nsk/v1/resources/cultures value: errors: - id: null code: nsk:Exceptions:OutOfRange message: nsk:Exceptions:OutOfRange type: Validation details: null rawMessage: 'The value ''asdf'' is out of range for ''ResourceQueryBase.CultureCode''.\nExpected values: (en-US,ar-AE,ar-BH,ar-IQ,ar-KW,ar-QA,ar-SA,ar-SY,ca-ES,de-CH,de-DE,de-LI,en-AU,en-CA,en-GB,en-IE,en-NZ,en-PH,en-TT,en-ZA,en-ZW,es-ES,es-GT,es-MX,fr-CA,fr-FR,hi-IN,hu-HU,id-ID,it-IT,ja-JP,ko-KR,ms,ms-MY,nb-NO,pt-BR,ru-RU,sw,sw-KE,th-TH,vi-VN,zh-CN,zh-SG,zh-TW)' exception: null debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only. data: null '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPassengerType' examples: Retrieve Passenger Type Response: description: Example response for successfully retrieving a specified configured passenger type in the system. value: data: nonAdult: false passengerTypeCode: ADT name: Adult allowed: true inActive: false typeIndicator: 0 minimumAge: 18 maximumAge: 65 /api/nsk/v1/resources/PaymentMethods: get: tags: - resources summary: Retrieves the collection of payment method resources. description: 'GraphQL endpoint: resourcePaymentMethods' operationId: nsk_v1_resources_PaymentMethods_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 - name: currencyCode in: query description: The currency code. schema: type: - string - 'null' x-position: 6 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPaymentMethod' /api/nsk/v2/resources/paymentMethods/{paymentMethodCode}: get: tags: - resources summary: 'Retrieves the specific payment method resources that match the payment method code. If the payment method type is set, returns a list with a single payment method that matches both the payment method code and the payment method type.' description: 'A payment method is considered unique based on the payment method code and the payment method type. GraphQL endpoint: resourcePaymentMethodv2' operationId: nsk_v2_resources_paymentMethods_paymentMethodCode_get parameters: - name: paymentMethodCode in: path required: true description: The unique payment method code. schema: type: string x-position: 1 - name: PaymentMethodType in: query description: "The payment method type.\n \nEnumeration values: 0 = ExternalAccount, 1 = PrePaid, 2 = AgencyAccount, 3 = CustomerAccount, 4 = Voucher, 5 = Loyalty" schema: $ref: '#/components/schemas/PaymentMethodType' x-position: 2 - name: CurrencyCode in: query description: "The payment method code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 3 - name: CultureCode in: query description: "The payment method code.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPaymentMethod' /api/nsk/v1/resources/PaymentMethods/{paymentMethodCode}: get: tags: - resources summary: Retrieves the specific payment method resource. description: 'GraphQL endpoint: resourcePaymentMethod' operationId: nsk_v1_resources_PaymentMethods_paymentMethodCode_get parameters: - name: paymentMethodCode in: path required: true description: The unique payment method code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - 'null' x-position: 2 - name: currencyCode in: query description: The specific currency code. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPaymentMethod' deprecated: true /api/nsk/v1/resources/PersonInformationTypes: get: tags: - resources summary: Retrieves the collection of person information type resources. description: 'GraphQL endpoint: resourcePersonInfoTypes' operationId: nsk_v1_resources_PersonInformationTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPersonInformationType' /api/nsk/v1/resources/PersonInformationTypes/{personInformationTypeCode}: get: tags: - resources summary: Retrieves the specific person information type resource. description: 'GraphQL endpoint: resourcePersonInfoType' operationId: nsk_v1_resources_PersonInformationTypes_personInformationTypeCode_get parameters: - name: personInformationTypeCode in: path required: true description: "The unique person information type code. Please note that this should be a char\nand not a string.\n " schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfPersonInformationType' /api/nsk/v1/resources/PhoneTypes: get: tags: - resources summary: Retrieves the collection of phone number type resources. description: 'GraphQL endpoint: resourcePhoneTypes' operationId: nsk_v1_resources_PhoneTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPhoneType' /api/nsk/v1/resources/PhoneTypes/{phoneTypeCode}: get: tags: - resources summary: Retrieves the specific phone number type resource. description: 'GraphQL endpoint: resourcePhoneType' operationId: nsk_v1_resources_PhoneTypes_phoneTypeCode_get parameters: - name: phoneTypeCode in: path required: true description: The unique phone type. Please note that this should be a char and not a string. schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfPhoneType' /api/nsk/v1/resources/postalCodes: get: tags: - resources summary: Retrieves the collection of postal codes resources. description: 'GraphQL endpoint: resourcePostalCodes' operationId: nsk_v1_resources_postalCodes_get parameters: - name: CountryCode in: query description: "The country code.\n " schema: type: - string - 'null' maxLength: 2 minLength: 0 x-position: 1 - name: ProvinceStateCode in: query description: "The province state code.\n " schema: type: - string - 'null' maxLength: 3 minLength: 0 x-position: 2 - name: City in: query description: "The city.\n " schema: type: - string - 'null' maxLength: 32 minLength: 0 x-position: 3 - name: PageSize in: query description: "The default page size.\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 4 - name: LastPageKey in: query description: "Used to specify the last item of the page of the last set of records retrieved\nwhen paging was performed. This is optional.\n " schema: type: - string - 'null' x-position: 5 - name: PostalCode in: query description: "The postal code.\n " schema: type: - string - 'null' maxLength: 10 minLength: 0 x-position: 6 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfResourcePostalCodeResponse' /api/nsk/v1/resources/postalCodes/{postalCode}: get: tags: - resources summary: Retrieves the postal code resource. description: 'GraphQL endpoint: resourcePostalCode' operationId: nsk_v1_resources_postalCodes_postalCode_get parameters: - name: postalCode in: path required: true description: The unique postal code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfPostalCode' /api/nsk/v1/resources/printers: get: tags: - resources summary: Retrieves a collection of printer resources. description: 'GraphQL endpoint: resourcePrinters' operationId: nsk_v1_resources_printers_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPrinter' /api/nsk/v1/resources/printers/{printerCode}: get: tags: - resources summary: Retrieves a specific printer resource. description: 'GraphQL endpoint: resourcePrinter' operationId: nsk_v1_resources_printers_printerCode_get parameters: - name: printerCode in: path required: true description: The unique printer code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfPrinter' /api/nsk/v1/resources/ProductClasses: get: tags: - resources summary: Retrieves the collection of product class resources. description: 'GraphQL endpoint: resourceProductClasses' operationId: nsk_v1_resources_ProductClasses_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfProductClass' /api/nsk/v1/resources/ProductClasses/{productClassCode}: get: tags: - resources summary: Retrieves the specific product class resource. description: 'GraphQL endpoint: resourceProductClass' operationId: nsk_v1_resources_ProductClasses_productClassCode_get parameters: - name: productClassCode in: path required: true description: The code identifying the specific product class to retrieve. schema: type: string x-position: 1 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: - string - '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/IJsonResponseOfProductClass' /api/nsk/v1/resources/PromotionSettingTypes: get: tags: - resources summary: Retrieves the collection of promotion setting type resources. description: 'GraphQL endpoint: resourcePromotionSettingTypes' operationId: nsk_v1_resources_PromotionSettingTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfPromotionSettingType' /api/nsk/v1/resources/PromotionSettingTypes/{promotionSettingsTypeCode}: get: tags: - resources summary: Retrieves the specific promotion setting type resource. description: 'GraphQL endpoint: resourcePromotionSettingType' operationId: nsk_v1_resources_PromotionSettingTypes_promotionSettingsTypeCode_get parameters: - name: promotionSettingsTypeCode in: path required: true description: The code identifying the promotion settings type resource to retrieve schema: type: string x-position: 1 - name: cultureCode in: query description: The desired culture code for the resource. schema: type: - string - '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/IJsonResponseOfPromotionSettingType' /api/nsk/v1/resources/ProvinceStates: get: tags: - resources summary: Retrieves the collection of province state resources. description: 'GraphQL endpoint: resourceProvinceStates' operationId: nsk_v1_resources_ProvinceStates_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfProvinceState' /api/nsk/v1/resources/ProvinceStates/{provinceStateCode}: get: tags: - resources summary: Retrieves the specific province state resource. description: 'GraphQL endpoint: resourceProvinceState' operationId: nsk_v1_resources_ProvinceStates_provinceStateCode_get parameters: - name: provinceStateCode in: path required: true description: The unique province state code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfProvinceState' /api/nsk/v1/resources/queue/categories: get: tags: - resources summary: Gets a response with a list of QueueCategories that match the given parameters. description: 'GraphQL endpoint: queueCategoryResource' operationId: nsk_v1_resources_queue_categories_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfQueueCategory' /api/nsk/v1/resources/queue/categories/{queueCategoryCode}: get: tags: - resources summary: Gets a response with a single QueueCategory that match the given parameters. description: 'GraphQL endpoint: queueCategoryResourceById' operationId: nsk_v1_resources_queue_categories_queueCategoryCode_get parameters: - name: queueCategoryCode in: path required: true description: "Queue Category Code being requested. Please note that this should be a char and not a\nstring.\n " schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: '[Optional] The culture code for the resources.' schema: type: - string - 'null' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfQueueCategory' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/resources/reminderTimes: get: tags: - resources summary: 'Retrieves the collection of reminder time resource that contains valid times for all passenger travel notification timed events.' description: 'GraphQL endpoint: resourceReminderTimes' operationId: nsk_v1_resources_reminderTimes_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfReminderTime' /api/nsk/v1/resources/reminderTimes/{timedEventType}: get: tags: - resources summary: 'Retrieves a specific reminder time resource that contains valid times for a passenger travel notification timed event.' description: 'GraphQL endpoint: resourceReminderTime' operationId: nsk_v1_resources_reminderTimes_timedEventType_get parameters: - name: timedEventType in: path required: true description: "The timed event type. \nEnumeration values: 0 = Departure, 1 = Arrival" schema: $ref: '#/components/schemas/NotificationTimedEventType' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfReminderTime' /api/nsk/v1/resources/roles: post: tags: - resources summary: BETA - Creates a new role. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. GraphQL endpoint: resourceRoleAdd' operationId: nsk_v1_resources_roles_post requestBody: x-name: request description: The create role request. content: application/json: schema: $ref: '#/components/schemas/CreateRoleRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/resources/roles: get: tags: - resources summary: Retrieves the role resources. description: 'GraphQL endpoint: resourceRolesv2' operationId: nsk_v2_resources_roles_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfRolev2' /api/nsk/v1/resources/roles/{roleCode}: delete: tags: - resources summary: BETA - Delete a role. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. GraphQL endpoint: resourceRoleDelete' operationId: nsk_v1_resources_roles_roleCode_delete parameters: - name: roleCode in: path required: true description: The role code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v2/resources/roles/{roleCode}: get: tags: - resources summary: Retrieves a single role resource. description: 'GraphQL endpoint: resourceRolev2' operationId: nsk_v2_resources_roles_roleCode_get parameters: - name: roleCode in: path required: true description: The unique role code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRolev2' /api/nsk/v1/resources/roles/{roleCode}/settings: get: tags: - resources summary: Retrieves the resource. description: 'GraphQL endpoint: resourceRoleSettings' operationId: nsk_v1_resources_roles_roleCode_settings_get parameters: - name: roleCode in: path required: true description: The unique role code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfListOfRoleSettingv2' /api/nsk/v1/resources/RoleSettingTypes: get: tags: - resources summary: Retrieves the collection of role setting resources. description: 'GraphQL endpoint: resourceRoleSettingTypes' operationId: nsk_v1_resources_RoleSettingTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfRoleSettingType' /api/nsk/v1/resources/RoleSettingTypes/{roleSettingTypeCode}: get: tags: - resources summary: Retrieves the specific role setting resource. description: 'GraphQL endpoint: resourceRoleSettingType' operationId: nsk_v1_resources_RoleSettingTypes_roleSettingTypeCode_get parameters: - name: roleSettingTypeCode in: path required: true description: The unique role setting type code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRoleSettingType' /api/nsk/v1/resources/searchTypes: get: tags: - resources summary: Retrieves the localizations. description: 'GraphQL endpoint: localizationSearchType' operationId: nsk_v1_resources_searchTypes_get parameters: - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 1 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 2 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 3 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfEnumResource' /api/nsk/v2/resources/seatPropertyTypes: get: tags: - resources summary: Retrieves a list of seat property types. description: 'GraphQL endpoint: resourceSeatPropertyTypes' operationId: nsk_v2_resources_seatPropertyTypes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSeatPropertyType' /api/nsk/v2/resources/seatPropertyTypes/{seatPropertyTypeCode}: get: tags: - resources summary: Retrieves a single seat property type resource. description: 'GraphQL endpoint: resourceSeatPropertyTypev2' operationId: nsk_v2_resources_seatPropertyTypes_seatPropertyTypeCode_get parameters: - name: seatPropertyTypeCode in: path required: true description: The unique seat property type code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfSeatPropertyType' /api/nsk/v1/resources/settings: post: tags: - resources summary: Retrieves a resource setting and its related information. description: 'This is a post to easily allow special path characters. See /resources/settings/data to avoid manually parsing the data. GraphQL endpoint: resourceSettingCategory' operationId: nsk_v1_resources_settings_post parameters: - name: eTag in: query description: ETag for caching. schema: type: - string - 'null' x-position: 2 requestBody: x-name: request description: The resource settings request. content: application/json: schema: $ref: '#/components/schemas/SettingsCategoryRequest' required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfResourceCategoryItem' /api/nsk/v1/resources/settings/data: post: tags: - resources summary: Retrieves resource setting data based on the accept content type. description: 'This is a post to easily allow special path characters. GraphQL endpoint: resourceSettingCategoryJson' operationId: nsk_v1_resources_settings_data_post parameters: - name: eTag in: query description: ETag for caching. schema: type: - string - 'null' x-position: 2 requestBody: x-name: request description: The resource settings request. content: application/json: schema: $ref: '#/components/schemas/SettingsCategoryRequest' required: true x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '415': description: Unsupported media type. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: type: string /api/nsk/v1/resources/ShoppingAttributeGroups: get: tags: - resources summary: Retrieves the collection of shopping attribute group resources. description: 'GraphQL endpoint: resourceShoppingAttributeGroups' operationId: nsk_v1_resources_ShoppingAttributeGroups_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfShoppingAttributeGroup' /api/nsk/v1/resources/ShoppingAttributeGroups/{shoppingAttributeGroupCode}: get: tags: - resources summary: Retrieves the specific shopping attribute group resource. description: 'GraphQL endpoint: resourceShoppingAttributeGroup' operationId: nsk_v1_resources_ShoppingAttributeGroups_shoppingAttributeGroupCode_get parameters: - name: shoppingAttributeGroupCode in: path required: true description: The unique shopping attribute group code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfShoppingAttributeGroup' /api/nsk/v1/resources/ShoppingAttributes: get: tags: - resources summary: Retrieves the collection of shopping attribute resources. description: 'GraphQL endpoint: resourceShoppingAttributes' operationId: nsk_v1_resources_ShoppingAttributes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfShoppingAttribute' /api/nsk/v1/resources/ShoppingAttributes/{shoppingAttributeCode}: get: tags: - resources summary: Retrieves the specific shopping attribute resource. description: 'GraphQL endpoint: resourceShoppingAttribute' operationId: nsk_v1_resources_ShoppingAttributes_shoppingAttributeCode_get parameters: - name: shoppingAttributeCode in: path required: true description: The unique shopping attribute code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfShoppingAttribute' /api/nsk/v1/resources/singleSignOnProvider: get: tags: - resources summary: Retrieves a list of available single sign on providers. description: 'GraphQL endpoint: singleSignOnProviders' operationId: nsk_v1_resources_singleSignOnProvider_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSingleSignOnProvider' /api/nsk/v1/resources/singleSignOnProvider/{providerName}: get: tags: - resources summary: Retrieves a specific single sign on provider. description: 'GraphQL endpoint: singleSignOnProviderByName' operationId: nsk_v1_resources_singleSignOnProvider_providerName_get parameters: - name: providerName in: path required: true description: The single sign on provider name. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSingleSignOnProvider' /api/nsk/v1/resources/SsrGroups: get: tags: - resources summary: Retrieves the collection of ssr group resources. description: 'GraphQL endpoint: resourceSsrGroups' operationId: nsk_v1_resources_SsrGroups_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsrGroup' /api/nsk/v1/resources/SsrGroups/{ssrGroupCode}: get: tags: - resources summary: Retrieves the specific ssr group resource. description: 'GraphQL endpoint: resourceSsrGroup' operationId: nsk_v1_resources_SsrGroups_ssrGroupCode_get parameters: - name: ssrGroupCode in: path required: true description: The SSR Group Code wanted. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfSsrGroup' /api/nsk/v1/resources/SsrNests: get: tags: - resources summary: Retrieves the collection of ssr nest resources. description: 'GraphQL endpoint: resourceSsrNests' operationId: nsk_v1_resources_SsrNests_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsrNest' /api/nsk/v1/resources/SsrNests/{ssrNestCode}: get: tags: - resources summary: Retrieves the specific ssr nest resource. description: 'GraphQL endpoint: resourceSsrNest' operationId: nsk_v1_resources_SsrNests_ssrNestCode_get parameters: - name: ssrNestCode in: path required: true description: The unique ssr nest code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfSsrNest' /api/nsk/v1/resources/SsrRestrictionResults: get: tags: - resources summary: Retrieves the collection of ssr restriction result resources. description: 'GraphQL endpoint: resourceSsrRestrictionResults' operationId: nsk_v1_resources_SsrRestrictionResults_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsrRestrictionResult' /api/nsk/v1/resources/SsrRestrictionResults/{ssrRestrictionResultCode}: get: tags: - resources summary: Retrieves the specific ssr restriction result. resource. description: 'GraphQL endpoint: resourceSsrRestrictionResult' operationId: nsk_v1_resources_SsrRestrictionResults_ssrRestrictionResultCode_get parameters: - name: ssrRestrictionResultCode in: path required: true description: The unique ssr restriction result code. schema: type: string x-position: 1 - name: cultureCode in: query description: The unique culture code. schema: type: - string - '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/IJsonResponseOfSsrRestrictionResult' /api/nsk/v1/resources/Ssrs: get: tags: - resources summary: Retrieves the collection of ssr resources. description: 'GraphQL endpoint: resourceSsrs' operationId: nsk_v1_resources_Ssrs_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSsr' /api/nsk/v1/resources/Ssrs/{ssrCode}: get: tags: - resources summary: Retrieves the specific ssr resource. description: 'GraphQL endpoint: resourceSsr' operationId: nsk_v1_resources_Ssrs_ssrCode_get parameters: - name: ssrCode in: path required: true description: The unique ssr code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfSsr' /api/nsk/v1/resources/StandByPriorities: get: tags: - resources summary: Retrieves the collection of standby priority resources. description: 'GraphQL endpoint: resourceStandByPriorities' operationId: nsk_v1_resources_StandByPriorities_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfStandByPriority' /api/nsk/v1/resources/StandByPriorities/{standByPriorityCode}: get: tags: - resources summary: Retrieves the specific standby priority resource. description: 'GraphQL endpoint: resourceStandByPriority' operationId: nsk_v1_resources_StandByPriorities_standByPriorityCode_get parameters: - name: standByPriorityCode in: path required: true description: The unique standby priority code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfStandByPriority' /api/nsk/v1/resources/StationCategories: get: tags: - resources summary: Retrieves the collection of station category resources. description: 'GraphQL endpoint: resourceStationCategories' operationId: nsk_v1_resources_StationCategories_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfStationCategory' /api/nsk/v1/resources/StationCategories/{stationCategoryCode}: get: tags: - resources summary: Retrieves the specific station category resource. description: 'GraphQL endpoint: resourceStationCategory' operationId: nsk_v1_resources_StationCategories_stationCategoryCode_get parameters: - name: stationCategoryCode in: path required: true description: "The unique station category code. Please note that this should be a char and not a\nstring.\n " schema: type: string maxLength: 1 x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfStationCategory' /api/nsk/beta/resources/stations: post: tags: - resources summary: BETA - Creates a new station. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. This endpoint is also currently having some performance issues, expect delays when a request is submitted. The performance issues will be resolved prior to taking this endpoint out of beta. GraphQL endpoint: resourceStationAddBeta' operationId: nsk_beta_resources_stations_post requestBody: x-name: request description: The create station request. content: application/json: schema: $ref: '#/components/schemas/CreateStationRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/resources/Stations: get: tags: - resources summary: Retrieves the collection of station resources. description: 'GraphQL endpoint: resourceStations' operationId: nsk_v1_resources_Stations_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfStation' /api/nsk/beta/resources/stations/{stationCode}: put: tags: - resources summary: BETA - Updates a station. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. This endpoint is also currently having some performance issues, expect delays when a request is submitted. The performance issues will be resolved prior to taking this endpoint out of beta. GraphQL endpoint: resourceStationSetBeta' operationId: nsk_beta_resources_stations_stationCode_put parameters: - name: stationCode in: path required: true description: The unique identifier of a station. schema: type: string x-position: 1 requestBody: x-name: request description: The update station request. content: application/json: schema: $ref: '#/components/schemas/UpdateStationRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' patch: tags: - resources summary: BETA - Modifies a station. description: 'This is a beta endpoint and is not currently a long term supported endpoint. This endpoint may be removed in future updates. Beta endpoints are not available in all labs or for all customers of the API. This endpoint is part of the Allow Edit on Settings And Resources feature that is currently in progress. This endpoint is also currently having some performance issues, expect delays when a request is submitted. The performance issues will be resolved prior to taking this endpoint out of beta. GraphQL endpoint: resourceStationModifyBeta' operationId: nsk_beta_resources_stations_stationCode_patch parameters: - name: stationCode in: path required: true description: The unique identifier of a station. schema: type: string x-position: 1 requestBody: x-name: request description: The update station request. content: application/json: schema: $ref: '#/components/schemas/DeltaMapperOfUpdateStationRequest' required: true x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '500': description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/resources/Stations/{stationCode}: get: tags: - resources summary: Retrieves the specific station resource. description: 'GraphQL endpoint: resourceStationv2' operationId: nsk_v1_resources_Stations_stationCode_get parameters: - name: stationCode in: path required: true description: The unique station code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - 'null' x-position: 2 - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfStation' /api/nsk/v1/resources/stations/{stationCode}/details: get: tags: - resources summary: Get the station details. description: 'Note this endpoint is not cached like other resource endpoints. GraphQL endpoint: resourceStationDetails' operationId: nsk_v1_resources_stations_stationCode_details_get parameters: - name: stationCode in: path required: true description: The station code. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfStationDetail' /api/nsk/v1/resources/stations/category/{stationCategoryCode}: get: tags: - resources summary: Gets a response with stations filtered by category. description: 'This endpoint is resource intensive until cached. GraphQL endpoint: resourceStationsByCategory' operationId: nsk_v1_resources_stations_category_stationCategoryCode_get parameters: - name: stationCategoryCode in: path required: true description: "The unique station category code. Please note that this should be a char and not a\nstring.\n " schema: type: string maxLength: 1 x-position: 1 - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 2 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 3 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 4 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 6 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfStation' /api/nsk/v1/resources/Suffixes: get: tags: - resources summary: Retrieves the collection of suffix resources. description: 'GraphQL endpoint: resourceSuffixes' operationId: nsk_v1_resources_Suffixes_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSuffix' /api/nsk/v1/resources/Suffixes/{suffixCode}: get: tags: - resources summary: Retrieves the specific suffix resource. description: 'GraphQL endpoint: resourceSuffix' operationId: nsk_v1_resources_Suffixes_suffixCode_get parameters: - name: suffixCode in: path required: true description: The unique suffix code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture for the suffix. schema: type: - string - '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/IJsonResponseOfSuffix' /api/dcs/v1/resources/tailNumbers: get: tags: - resources summary: Retrieves the tail number inventory. description: 'GraphQL endpoint: dcsResourceTailNumberInventory' operationId: dcs_v1_resources_tailNumbers_get parameters: - name: eTag in: query description: The resource eTag. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTailNumberInventoryItem' /api/nsk/v1/resources/TimeZones: get: tags: - resources summary: Retrieves the collection of time zone resources. description: 'GraphQL endpoint: resourceTimeZones' operationId: nsk_v1_resources_TimeZones_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTimeZone' /api/nsk/v1/resources/TimeZones/{timeZoneCode}: get: tags: - resources summary: Retrieves the specific time zone resource. description: 'GraphQL endpoint: resourceTimeZonev2' operationId: nsk_v1_resources_TimeZones_timeZoneCode_get parameters: - name: timeZoneCode in: path required: true description: The unique time zone code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - 'null' x-position: 2 - name: eTag in: query description: The eTag. schema: type: - string - 'null' x-position: 3 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTimeZone' /api/nsk/v1/resources/Titles: get: tags: - resources summary: Retrieves the collection of title resources. description: 'GraphQL endpoint: resourceTitles' operationId: nsk_v1_resources_Titles_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTitle' examples: Retrieve titles response: description: Example response for successfully retrieving the configured titles in the system. value: data: - titleKey: MR description: Mr. gender: 1 weightCategory: 1 inActive: false declaredGender: M - titleKey: MS description: Ms. gender: 2 weightCategory: 2 inActive: false declaredGender: F - titleKey: Mx description: Undisclosed gender: 1 weightCategory: 1 inActive: false declaredGender: X - titleKey: Mu description: Unspecified gender: 1 weightCategory: 1 inActive: false declaredGender: U /api/nsk/v1/resources/Titles/{titleKey}: get: tags: - resources summary: Retrieves the specific title resource. description: 'GraphQL endpoint: resourceTitle' operationId: nsk_v1_resources_Titles_titleKey_get parameters: - name: titleKey in: path required: true description: The unique title key. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture for the title. schema: type: - string - '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/IJsonResponseOfTitle' /api/nsk/v1/resources/TravelClasses: get: tags: - resources summary: Retrieves the collection of travel class resources. description: 'GraphQL endpoint: resourceTravelClasses' operationId: nsk_v1_resources_TravelClasses_get parameters: - name: ActiveOnly in: query description: "Flag indicating to return just active only or all.\n " schema: type: boolean x-position: 1 - name: CultureCode in: query description: "The desired culture code to be returned.\n " schema: type: - string - 'null' maxLength: 17 minLength: 0 x-position: 2 - name: ETag in: query description: "The cache token for this request. Data will not be returned if etag still matches.\n " schema: type: - string - 'null' x-position: 3 - name: StartIndex in: query description: "The start index value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 4 - name: ItemCount in: query description: "The item count value for this request.\n " schema: type: - integer - 'null' format: int32 maximum: 2147483647.0 minimum: 0.0 x-position: 5 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTravelClass' /api/nsk/v1/resources/TravelClasses/{travelClassCode}: get: tags: - resources summary: Retrieves the specific travel class resource. description: 'GraphQL endpoint: resourceTravelClass' operationId: nsk_v1_resources_TravelClasses_travelClassCode_get parameters: - name: travelClassCode in: path required: true description: The unique travel class code. schema: type: string x-position: 1 - name: cultureCode in: query description: The specific culture code. schema: type: - string - '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/IJsonResponseOfTravelClass' /api/nsk/v1/resources/travelerNotifications: get: tags: - resources summary: Retrieves a collection of traveler notification resource. description: 'GraphQL endpoint: resourceTravelerNotifications' operationId: nsk_v1_resources_travelerNotifications_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTravelerNotification' /api/nsk/v1/resources/travelerNotifications/{notificationTypeCode}: get: tags: - resources summary: Retrieves the specified traveler notification resource. description: 'GraphQL endpoint: resourceTravelerNotification' operationId: nsk_v1_resources_travelerNotifications_notificationTypeCode_get parameters: - name: notificationTypeCode in: path required: true description: Traveler notification type. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfTravelerNotification' /api/nsk/v1/resources/travelerNotifications/deliveryMethods: get: tags: - resources summary: Retrieves the traveler notification delivery methods filtered by program code and level. description: 'This endpoint will return the allowed traveler notification delivery methods based on the program code and level. Any delivery methods that have a required program and level where the passed in values do not meet that level or above will be removed. If the customer is not enrolled in the default loyalty program, leave the program code and level null and the delivery methods will be filtered appropriately. GraphQL endpoint: resourceTravelerNotificationDeliveryMethods' operationId: nsk_v1_resources_travelerNotifications_deliveryMethods_get parameters: - name: programCode in: query description: The customer's default loyalty program code. schema: type: - string - 'null' x-position: 1 - name: programLevel in: query description: The customer's program level of their default loyalty program. schema: type: - string - 'null' x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfTravelerNotificationDeliveryMethod' /api/nsk/v1/resources/travelerNotifications/deliveryMethodSettings: get: tags: - resources summary: Retrieves the notification delivery method settings resource. description: 'Contains information about the SMS, PUSH, and EMAIL notification delivery methods and their maximum number of allowed notifications. GraphQL endpoint: resourceNotificationDeliveryMethodSettings' operationId: nsk_v1_resources_travelerNotifications_deliveryMethodSettings_get parameters: - name: eTag in: query description: The unique etag ID. schema: type: - string - 'null' x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '304': description: The requested item has not been modified. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfNotificationDeliveryMethod' /api/nsk/v1/resources/zones/{zoneCode}/subZones: get: tags: - resources summary: Retrieves the collection of subzones. description: 'This endpoint does not cache the resulting subzone resources. GraphQL endpoint: resourceSubZonesv2' operationId: nsk_v1_resources_zones_zoneCode_subZones_get parameters: - name: zoneCode in: path required: true description: The unique code of the zone to which the subzones belong. schema: type: string x-position: 1 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfSubZonev2' /api/nsk/v1/resources/zones/{zoneCode}/subZones/{subZoneCode}: get: tags: - resources summary: Retrieves the specific subzone. description: 'This endpoint does not retrieve the subzone resource from the cache. GraphQL endpoint: resourceSubZonev2' operationId: nsk_v1_resources_zones_zoneCode_subZones_subZoneCode_get parameters: - name: zoneCode in: path required: true description: The unique code of the zone to which the subzones belong. schema: type: string x-position: 1 - name: subZoneCode in: path required: true description: The unique subzone code. schema: type: string x-position: 2 responses: '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfSubZonev2' components: schemas: SettingsCategoryRequest: type: object description: "Model representing a settings category request.\n " additionalProperties: false required: - path properties: path: type: string description: "The path of the setting. Example: Web\\dotREZ\\MarketFilterSettings.\n " minLength: 1 RegionIdentifier: type: object description: "The region identifier model.\n " additionalProperties: false properties: regionTypeCode: type: - string - 'null' description: "The region type code.\n " maxLength: 5 minLength: 0 regionType: description: "The region type.\n " $ref: '#/components/schemas/RegionType' exclude: type: - boolean - 'null' description: "The flag to indicate if this is not in the travel region.\n " ChallengeCodeContactMethod: type: integer description: "Indicates the required contact method for sending challenge codes.\n \n\n0 = None\n1 = Email\n2 = Phone\n3 = All" x-enumNames: - None - Email - Phone - All enum: - 0 - 1 - 2 - 3 CustomerProgram: type: object description: "The customer program such as loyalty programs.\n " additionalProperties: false properties: programCode: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 0 programType: description: "The program type.\n " $ref: '#/components/schemas/ProgramType' validationType: type: - string - 'null' description: "The validation type.\n " inActive: type: boolean description: "Is in-active.\n " qualifyingSegments: type: integer description: "The qualifying segments.\n " qualifyingPoints: type: integer description: "The qualifying points.\n " format: int32 pointBalance: type: integer description: "The point balance.\n " format: int32 customerProgramLevels: type: - array - 'null' description: "The customer program levels.\n " items: $ref: '#/components/schemas/CustomerProgramLevel' IJsonResponseOfCommissionRate: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CommissionRate' 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' IJsonResponseOfBundleConfiguration: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/BundleConfiguration' 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' BundleSsrConfiguration: type: object description: "The bundle ssr configuration model.\n " additionalProperties: false properties: ssrCode: type: - string - 'null' description: "The ssr code.\n " maxLength: 4 minLength: 0 currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 discountPercent: type: number description: "The discount percent.\n " format: decimal maximum: 1.0 minimum: 0.0 ssrNumber: type: integer description: "The SSR number.\n " isFeeWaived: type: boolean description: "Indicates if the service fee is waived.\n " amounts: type: - array - 'null' description: "The service bundle SSR discount amounts.\n " items: $ref: '#/components/schemas/BundleDiscountAmount' bundleCode: type: - string - 'null' description: "The service bundle code.\n " maxLength: 4 minLength: 0 upgradeFromSsrCode: type: - string - 'null' description: "The ssr code that was upgraded.\n " maxLength: 4 minLength: 0 bundleSsrType: description: "The bundle ssr type.\n " $ref: '#/components/schemas/BundleSsrType' SubZonev2: type: object description: "The version two of the subzone model.\n " additionalProperties: false required: - subZoneCode - zoneCode properties: name: type: - string - 'null' description: "Gets or sets the name of this subzone.\n " maxLength: 64 minLength: 0 subZoneCode: type: string description: "Gets or sets the subzone code for this subzone.\n " maxLength: 3 minLength: 1 zoneCode: type: string description: "Gets or sets the zone code for this subzone.\n " maxLength: 2 minLength: 1 IJsonResponseOfAccountTransactionCode: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/AccountTransactionCode' 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' IJsonResponseOfIListOfNonBinaryGender: 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/NonBinaryGender' 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' ProgramType: type: integer description: "The program type enumeration.\n \n\n0 = Default\n1 = Internal\n2 = External" x-enumNames: - Default - Internal - External enum: - 0 - 1 - 2 IJsonResponseOfIListOfDepartment: 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/Department' 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' IJsonResponseOfRolev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Rolev2' 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' Area: type: object description: "The area model.\n " additionalProperties: false properties: areaCode: type: - string - 'null' description: "Gets or sets the code for this area.\n " maxLength: 3 minLength: 1 description: type: - string - 'null' description: "Gets or sets the description of this area.\n " maxLength: 128 minLength: 0 name: type: - string - 'null' description: "Gets or sets the name of this area.\n " maxLength: 64 minLength: 0 zones: type: - array - 'null' description: "Gets or sets the list of zones associated with this area.\n " items: $ref: '#/components/schemas/Zone' IJsonResponseOfIListOfMarketRoute: 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/MarketRoute' 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' IJsonResponseOfFee: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Fee' 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' SeatRestriction: type: integer description: "The seat restriction enumeration.\n \n\n0 = Undefined\n1 = AlwaysAllowed\n2 = DefaultAllowed\n3 = DefaultRestricted" x-enumNames: - Undefined - AlwaysAllowed - DefaultAllowed - DefaultRestricted enum: - 0 - 1 - 2 - 3 TimeZoneVariation: type: object description: "The time zone variation model.\n " additionalProperties: false properties: endUtc: type: - string - 'null' description: "Gets or sets the End UTC time variation.\n " format: date-time startUtc: type: - string - 'null' description: "Gets or sets the Start UTC time variation.\n " format: date-time variation: type: integer description: "Gets or sets the variation.\n " SubZone: type: object description: "The subzone model.\n " deprecated: true x-deprecatedMessage: 4.4.1 - Please use SubZonev2 instead. additionalProperties: false required: - subZoneCode - zoneCode - areaCode properties: name: type: - string - 'null' description: "Gets or sets the name of this subzone.\n " maxLength: 64 minLength: 0 subZoneCode: type: string description: "Gets or sets the subzone code for this subzone.\n " maxLength: 3 minLength: 1 zoneCode: type: string description: "Gets or sets the zone code for this subzone.\n " maxLength: 2 minLength: 1 areaCode: type: string description: "Gets or sets the area code for this subzone.\n " maxLength: 3 minLength: 1 stations: type: - array - 'null' description: "Gets or sets the list of stations associated with this subzone.\n " items: $ref: '#/components/schemas/Station' FeeType: type: integer description: "Enumeration representing all the different fee types.\n \n\n0 = All\n1 = Tax\n2 = TravelFee\n3 = ServiceFee\n4 = PaymentFee\n5 = PenaltyFee\n6 = SsrFee\n7 = NonFlightServiceFee\n8 = UpgradeFee\n9 = SeatFee\n10 = BaseFare\n11 = SpoilageFee\n12 = NameChangeFee\n13 = ConvenienceFee\n14 = BaggageFee\n15 = FareSurcharge\n16 = PromotionDiscount\n17 = ServiceBundle\n18 = ExtraBagFee\n19 = ATPCOBagFee" x-enumNames: - All - Tax - TravelFee - ServiceFee - PaymentFee - PenaltyFee - SsrFee - NonFlightServiceFee - UpgradeFee - SeatFee - BaseFare - SpoilageFee - NameChangeFee - ConvenienceFee - BaggageFee - FareSurcharge - PromotionDiscount - ServiceBundle - ExtraBagFee - ATPCOBagFee enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 IJsonResponseOfPersonInformationType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PersonInformationType' 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' Location: type: object description: "The location model.\n " additionalProperties: false properties: locationCode: type: - string - 'null' description: "The Location Code.\n " maxLength: 5 minLength: 0 name: type: - string - 'null' description: "The Name.\n " maxLength: 64 minLength: 0 locationType: description: "The location type.\n " $ref: '#/components/schemas/LocationType' paymentGroupId: type: integer description: "The payment group id.\n " format: int64 maximum: 9.223372036854776e+18 minimum: 0.0 cultureCode: type: - string - 'null' description: "The culture code.\n " maxLength: 17 minLength: 1 currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 1 inActive: type: boolean description: "The in active.\n " StandByPriority: type: object description: "The stand by priority model.\n " additionalProperties: false properties: standByPriorityCode: type: - string - 'null' description: "The priority code.\n " name: type: - string - 'null' description: "the name.\n " priorityCategory: type: - string - 'null' description: "the priority category\n " inActive: type: boolean description: "the in active.\n " MarketLocationType: type: integer description: "Enum representing the type of location of a market point.\n \n\n0 = Undefined\n1 = Station\n3 = Mac" x-enumNames: - Undefined - Station - Mac enum: - 0 - 1 - 3 IJsonResponseOfIListOfPrinter: 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/Printer' 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' FeeRuleOperator: type: integer description: "Enum for fee rule operator.\n \n\n0 = Default\n1 = MustBe\n2 = MustNotBe" x-enumNames: - Default - MustBe - MustNotBe enum: - 0 - 1 - 2 IJsonResponseOfCity: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/City' 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' IJsonResponseOfAddressType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/AddressType' 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' IJsonResponseOfIListOfIssuanceReason: 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/IssuanceReason' 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' ResponseContentType: type: integer description: "Defines the content data type enumeration.\n \n\n0 = Unknown\n1 = Json\n2 = Xml" x-enumNames: - Unknown - Json - Xml enum: - 0 - 1 - 2 IJsonResponseOfReminderTime: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ReminderTime' 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' BundleDiscountAmount: type: object description: "The discount amount details for an SSR bundle.\n " additionalProperties: false properties: currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 amount: type: number description: "The discount amount.\n " format: decimal ssrNumber: type: integer description: "The SSR number.\n " PassengerTypeIndicator: type: integer description: "Passenger type indicator.\n \n\n0 = Adult\n1 = Infant\n2 = Child\n3 = NonAdult" x-enumNames: - Adult - Infant - Child - NonAdult enum: - 0 - 1 - 2 - 3 IJsonResponseOfIListOfReminderTime: 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/ReminderTime' 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' PaymentMethod: type: object description: "The payment method model.\n " additionalProperties: false required: - paymentMethodCode - name properties: paymentMethodCode: type: string description: "The payment method code for this payment method.\n " maxLength: 2 minLength: 0 allowDeposit: type: boolean description: "The allow deposit flag for this payment method.\n " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes endpoint to verify role based access instead.\n " allowZeroAmount: type: boolean description: "The allow zero amount flag for this payment method.\n " commissionable: type: boolean description: "The commissionable flag for this payment method.\n " dccType: description: "The DCC type for this payment method.\n " $ref: '#/components/schemas/DccType' disallowPartialRefund: type: boolean description: "The disallow partial refund flag for this payment method.\n " feeCode: type: - string - 'null' description: "The fee code for this payment method.\n " maxLength: 6 minLength: 0 inActive: type: boolean description: "The inactive flag for this payment method.\n " maxInstallments: type: integer description: "The max installments for this payment method.\n " name: type: string description: "The name for this payment method.\n " maxLength: 64 minLength: 0 paymentMethodFields: type: - object - 'null' description: "The payment method fields for this payment method.\n " additionalProperties: $ref: '#/components/schemas/PaymentMethodField' paymentMethodType: description: "The payment method type for this payment method.\n " $ref: '#/components/schemas/PaymentMethodType' paymentRefundType: description: "The payment refund type for this payment method.\n " $ref: '#/components/schemas/PaymentRefundType' proportionalRefund: type: boolean description: "The proportional refund flag for this payment method.\n " refundableByAgent: type: boolean description: "The refundable by agent flag for this payment method.\n " refundCurrencyControl: description: "The refund currency control for this payment method.\n " $ref: '#/components/schemas/RefundCurrencyControl' restrictionHours: type: integer description: "The hours of restriction for this payment method.\n " systemControlled: type: boolean description: "The system controlled flag for this payment method.\n " traceQueueCode: type: - string - 'null' description: "The trace queue code for this payment method.\n " maxLength: 6 minLength: 0 validationRequired: type: boolean description: "The validation required flag for this payment method.\n " enableDeviceDataCollectionWithJwt: type: boolean description: "Whether device data collection with jwt is enabled.\n " SeatPropertyTypeKind: type: integer description: "Seat property type kind enumeration.\n \n\n0 = None\n1 = Boolean\n2 = Numeric\n3 = List\n4 = String\n5 = SsrPermission" x-enumNames: - None - Boolean - Numeric - List - String - SsrPermission enum: - 0 - 1 - 2 - 3 - 4 - 5 PostalCode: type: object description: "The postal code model.\n " additionalProperties: false required: - countryCode - provinceStateCode properties: code: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 1 cityName: type: - string - 'null' description: "The city name for this postal code.\n " maxLength: 64 minLength: 0 countryCode: type: string description: "The two-digit country code for this postal code.\n " maxLength: 2 minLength: 1 provinceStateCode: type: string description: "The province state code for this postal code.\n " maxLength: 3 minLength: 1 IJsonResponseOfIListOfCustomerProgramv2: 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/CustomerProgramv2' 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' IJsonResponseOfIListOfPaymentMethod: 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/PaymentMethod' 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' PaymentMethodField: type: object description: "The payment method field model.\n " additionalProperties: false required: - paymentMethodFieldCode - name - paymentMethodCode properties: paymentMethodFieldCode: type: string description: "The code for this payment field\n " maxLength: 32 minLength: 0 bookingPaymentField: description: "The field category for this payment field.\n " $ref: '#/components/schemas/BookingPaymentField' name: type: string description: "The name of this payment field\n " maxLength: 64 minLength: 0 ordinal: type: integer description: "The order number for this payment field.\n " paymentMethodCode: type: string description: "The payment method code for this payment field.\n " maxLength: 2 minLength: 0 paymentMethodType: description: "The payment method type for this payment field.\n " $ref: '#/components/schemas/PaymentMethodType' persistData: type: boolean description: "The persist data flag for this payment field.\n " refundUiState: description: "The refund ui state for this payment field.\n " $ref: '#/components/schemas/RefundState' requiredType: description: "The required type for this payment field.\n " $ref: '#/components/schemas/RequiredType' valueMaxLength: type: integer description: "The value max length for this payment field.\n " valueMinLength: type: integer description: "The value min length for this payment field.\n " valueRegEx: type: - string - 'null' description: "The Regular Expression for this payment field.\n " maxLength: 128 minLength: 0 valueType: description: "The value type for this payment field.\n " $ref: '#/components/schemas/ValueType' IJsonResponseOfCurrencyv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Currencyv2' 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' IJsonResponseOfIListOfSuffix: 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/Suffix' 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' IJsonResponseOfContactType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ContactType' 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' IJsonResponseOfIListOfExternalSystem: 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/ExternalSystem' 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' SsrGroup: type: object description: "The sell service request (SSR) group model.\n " additionalProperties: false properties: ssrGroupCode: type: - string - 'null' description: "The SSR group Code.\n " maxLength: 4 minLength: 1 name: type: - string - 'null' description: "The Name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The in active.\n " ssrs: type: - array - 'null' description: "The Collection of SSRs.\n " items: $ref: '#/components/schemas/SsrGroupItem' AddressType: type: object description: "The Address Type\n " additionalProperties: false required: - addressTypeCode properties: addressTypeCode: type: string description: "The address type code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 minLength: 1 name: type: - string - 'null' description: "The name of the address type.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The InActive of Address type.\n " IJsonResponseOfIListOfProductClass: 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/ProductClass' 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' WeightType: type: integer description: "Weight Type enumeration.\n \n\n0 = Default\n1 = Pounds\n2 = Kilograms" x-enumNames: - Default - Pounds - Kilograms enum: - 0 - 1 - 2 IJsonResponseOfIListOfDelay: 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/Delay' 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' UpdateStationRequest: type: object description: "Defines the update station request.\n " additionalProperties: false required: - inActive - fullName - shortName - currencyCode - cultureCode - latitude - longitude - zoneCode - subZoneCode - countryCode - cityCode - timeZoneCode - weightType properties: inActive: type: boolean description: "The flag indicating if the station is inactive.\n " icaoCode: type: - string - 'null' description: "The International Civil Aviation Organization (ICAO) code for the station.\n " maxLength: 4 minLength: 0 fullName: type: string description: "The full display name.\n " maxLength: 64 minLength: 0 shortName: type: string description: "The short display name.\n " maxLength: 32 minLength: 0 macCode: type: - string - 'null' description: "The MAC (Multiple Airport Code) code.\n " maxLength: 3 minLength: 0 currencyCode: type: string description: "The default currency code.\n " maxLength: 3 minLength: 0 conversionCurrencyCode: type: - string - 'null' description: "The configured conversion currency code.\n " maxLength: 3 minLength: 0 cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 stationClass: type: string description: "The configured class.\nPlease note that this should be a char and not a string.\n " maxLength: 1 latitude: type: string description: "The coordinates of the station.\n " maxLength: 10 minLength: 0 longitude: type: string description: "The coordinates of the station.\n " maxLength: 11 minLength: 0 zoneCode: type: string description: "The geographical location code (i.e. North America, Europe).\n " maxLength: 2 minLength: 0 subZoneCode: type: string description: "The sub zone code based on the geographical location (i.e. USA, Canada).\n " maxLength: 3 minLength: 0 countryCode: type: string description: "The country code the station exists in.\n " maxLength: 2 minLength: 0 provinceStateCode: type: - string - 'null' description: "The province or state the station exists in.\n " maxLength: 3 minLength: 0 cityCode: type: string description: "The city the station exists in.\n " maxLength: 3 minLength: 0 timeZoneCode: type: string description: "The configured timezone of the station.\n " maxLength: 4 minLength: 0 thirdPartyControlled: type: boolean description: "The flag indicating if the station is controlled via a third party.\n " weightType: description: "The configured weight units of measurement.\n " $ref: '#/components/schemas/WeightType' DataRange: type: object description: "The data range model.\n " additionalProperties: false properties: minimum: type: - integer - 'null' description: "The minimum range.\n " maximum: type: - integer - 'null' description: "The maximum range.\n " MessageType: type: object description: "The message type model.\n " additionalProperties: false required: - messageTypeCode properties: messageTypeCode: type: string description: "The reason code.\n " maxLength: 4 minLength: 0 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The in active.\n " TravelLocationsRequired: type: integer description: "Enum representing when travel documents are required in a market.\n \n\n0 = None\n1 = FromTravel\n2 = ToTravel\n3 = BothTravel" x-enumNames: - None - FromTravel - ToTravel - BothTravel enum: - 0 - 1 - 2 - 3 Fee: type: object description: "Fee Model.\n " additionalProperties: false properties: canBeManuallyAdded: type: boolean description: "Returns true if this fee can be manually added.\n " hasDefaultFeePrice: type: boolean description: "Returns true if this fee can be queried to check the default price.\n " isFeeChargedPerSegment: type: boolean description: "Returns true if the given fee code is charged per segment/leg.\n " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes endpoint to verify role based access instead.\n " chargeLimit: type: integer description: "Gets or sets the charge limit of this fee.\n " maximum: 32767.0 minimum: 0.0 chargeLimitMode: description: "Gets or sets when the charge limit is applied to this fee.\n " $ref: '#/components/schemas/ChargeLimitMode' chargeLimitTravelComponent: description: "Gets or sets the charge limit for the travel component associated with this fee.\n " $ref: '#/components/schemas/TravelComponent' commissionable: type: boolean description: "Gets or sets the commissionable flag for this fee.\n " countryCode: type: - string - 'null' description: "Gets or sets the country code for this fee.\n " maxLength: 2 minLength: 0 description: type: - string - 'null' description: "Gets or sets the description for this fee.\n " maxLength: 128 minLength: 0 displayCode: type: - string - 'null' description: "Gets or sets the display code for this fee.\n " maxLength: 3 minLength: 0 feeApplication: description: "Gets or sets how this fee is applied.\n " $ref: '#/components/schemas/FeeApplication' feeCode: type: - string - 'null' description: "Gets or sets the code for this fee.\n " maxLength: 6 minLength: 0 feeOptionMode: description: "Gets or sets the fee option mode for this fee.\n " $ref: '#/components/schemas/FeeOptionMode' feeType: description: "Gets or sets the fee type for this fee.\n " $ref: '#/components/schemas/FeeType' inActive: type: boolean description: "Gets or sets the inactive flag for this fee.\n " itemizable: type: boolean description: "Gets or sets the itemizable flag for this fee.\n " minStopover: type: integer description: "Gets or sets the MinStopover of this fee.\n " maximum: 32767.0 minimum: 0.0 minStopoverInternational: type: integer description: "Gets or sets the International MinStopover of this fee.\n " maximum: 32767.0 minimum: 0.0 name: type: - string - 'null' description: "Gets or sets the name of this fee.\n " maxLength: 64 minLength: 0 taxApplication: description: "Gets or sets how the taxes are applied for this fee.\n " $ref: '#/components/schemas/TaxApplication' ticketable: type: boolean description: "Gets or sets the ticketable flag for this fee.\n " travelComponent: description: "Gets or sets the travel component associated with this fee.\n " $ref: '#/components/schemas/TravelComponent' BundleConfiguration: type: object description: "The bundle configuration model.\n " additionalProperties: false properties: bundleCode: type: - string - 'null' description: "The service bundle code.\n " maxLength: 4 minLength: 0 feeCode: type: - string - 'null' description: "The SSR fee code.\n " maxLength: 6 minLength: 0 bookingQueueCode: type: - string - 'null' description: "The booking queue code.\n " maxLength: 6 minLength: 0 programCode: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 programLevel: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 name: type: - string - 'null' description: "The bundle name.\n " maxLength: 64 minLength: 0 description: type: - string - 'null' description: "The bundle description.\n " maxLength: 128 minLength: 0 hasPrice: type: boolean description: "Indicates if the bundle type has a cost associated with it.\n " rank: type: integer description: "The bundle rank.\n " maximum: 32767.0 minimum: 1.0 inActive: type: boolean description: "Indicates if the bundle is active.\n " allSsrsRequired: type: boolean description: "Indicates if all SSR's are required.\n " serviceBundleType: description: "The type of the bundle\n " $ref: '#/components/schemas/ServiceBundleType' FareSurchargeAmount: type: object description: "The fare surcharge amount model.\n " additionalProperties: false properties: fareSurchargeCode: type: - string - 'null' description: "The fare surcharge code.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " amount: type: number description: "The amount.\n " format: decimal PromotionSettingType: type: object description: "The promotion setting type model.\n " additionalProperties: false required: - promotionSettingTypeCode properties: promotionSettingTypeCode: type: string description: "The promotion setting type code.\n " minLength: 1 name: type: - string - 'null' description: "The setting type name.\n " inActive: type: boolean description: "In active\n " schema: type: - string - 'null' description: "The data schema.\n " maxLength: 2147483647 minLength: 0 IJsonResponseOfIListOfClassOfService: 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/ClassOfService' 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' IJsonResponseOfIListOfSsr: 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/Ssr' 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' IJsonResponseOfIListOfProvinceState: 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/ProvinceState' 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' AccountTransactionCode: type: object description: "The account transaction code model.\n " additionalProperties: false required: - transactionCode properties: transactionCode: type: string description: "The unique transaction code.\n " maxLength: 6 minLength: 0 name: type: - string - 'null' description: "The Name.\n " maxLength: 64 minLength: 0 expirationType: description: "The expiration type.\n " $ref: '#/components/schemas/CreditExpirationType' expirationDays: type: integer description: "The expiration days.\n " expirationDate: type: - string - 'null' description: "The expiration date.\n " format: date-time inActive: type: boolean description: "In active.\n " IJsonResponseOfIListOfPersonInformationType: 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/PersonInformationType' 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' DeltaMapperOfUpdateStationRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: inActive: type: boolean description: "The flag indicating if the station is inactive.\n " icaoCode: type: - string - 'null' description: "The International Civil Aviation Organization (ICAO) code for the station.\n " maxLength: 4 minLength: 0 fullName: type: string description: "The full display name.\n " maxLength: 64 minLength: 0 shortName: type: string description: "The short display name.\n " maxLength: 32 minLength: 0 macCode: type: - string - 'null' description: "The MAC (Multiple Airport Code) code.\n " maxLength: 3 minLength: 0 currencyCode: type: string description: "The default currency code.\n " maxLength: 3 minLength: 0 conversionCurrencyCode: type: - string - 'null' description: "The configured conversion currency code.\n " maxLength: 3 minLength: 0 cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 stationClass: type: string description: "The configured class.\nPlease note that this should be a char and not a string.\n " maxLength: 1 latitude: type: string description: "The coordinates of the station.\n " maxLength: 10 minLength: 0 longitude: type: string description: "The coordinates of the station.\n " maxLength: 11 minLength: 0 zoneCode: type: string description: "The geographical location code (i.e. North America, Europe).\n " maxLength: 2 minLength: 0 subZoneCode: type: string description: "The sub zone code based on the geographical location (i.e. USA, Canada).\n " maxLength: 3 minLength: 0 countryCode: type: string description: "The country code the station exists in.\n " maxLength: 2 minLength: 0 provinceStateCode: type: - string - 'null' description: "The province or state the station exists in.\n " maxLength: 3 minLength: 0 cityCode: type: string description: "The city the station exists in.\n " maxLength: 3 minLength: 0 timeZoneCode: type: string description: "The configured timezone of the station.\n " maxLength: 4 minLength: 0 thirdPartyControlled: type: boolean description: "The flag indicating if the station is controlled via a third party.\n " weightType: description: "The configured weight units of measurement.\n " $ref: '#/components/schemas/WeightType' IJsonResponseOfIListOfStation: 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/Station' 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' IJsonResponseOfExternalSystem: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ExternalSystem' 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' Directionality: type: integer description: "Enum representing direction of an object.\n \n\n0 = None\n1 = To\n2 = From\n3 = Between" x-enumNames: - None - To - From - Between enum: - 0 - 1 - 2 - 3 Rolev2: type: object description: "Represents information about a role.\n " additionalProperties: false properties: roleCode: type: - string - 'null' description: "The unique role code.\n " name: type: - string - 'null' description: "The role's name.\n " parentRoleCode: type: - string - 'null' description: "Gets or sets the parent role code for this role.\n " maxLength: 4 minLength: 1 CreateRoleRequest: type: object description: "Create role request.\n " additionalProperties: false required: - roleCode - name - parentRoleCode properties: roleCode: type: string description: "The unique role code.\n " maxLength: 4 minLength: 1 name: type: string description: "The role's name.\n " minLength: 1 parentRoleCode: type: string description: "Gets or sets the parent role code for this role.\n " maxLength: 4 minLength: 1 BundleApplication: type: object description: "The bundle application model.\n " additionalProperties: false properties: bundleApplicationKey: type: - string - 'null' description: "The bundle application key.\n " bundleSetCode: type: - string - 'null' description: "The code of the bundle set to which the\nbundle application applies.\n " regionFilter: description: "The details related to the region filter for the bundle application.\n " $ref: '#/components/schemas/RegionFilter' passengerCounts: description: "The minimum and maximum passenger counts.\n " $ref: '#/components/schemas/DataRange' travelMinutes: description: "The minimum and maximum travel minutes.\n " $ref: '#/components/schemas/DataRange' advancedPurchaseHours: description: "The minimum and maximum advanced purchase hours.\n " $ref: '#/components/schemas/DataRange' dates: description: "The important dates associated with a bundle application.\n " $ref: '#/components/schemas/BundleDates' appliesToAllSegments: type: boolean description: "Indicates if the service bundle applies to all segments or not.\n " codeShareType: type: - string - 'null' description: "The code share type.\nPlease note that this should be a char and not a string.\n " maxLength: 1 sequenceNumber: type: integer description: "The sequence number.\n " IJsonResponseOfIListOfCurrencyv2: 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/Currencyv2' 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' IJsonResponseOfIListOfFareDiscount: 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/FareDiscount' 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' TravelerNotification: type: object description: "Traveler notification model.\n " additionalProperties: false properties: createdUserKey: type: - string - 'null' description: "The created user key.\n " createdDate: type: - string - 'null' description: "The date and time the object was created.\n " format: date-time notificationTypeCode: type: - string - 'null' description: "Notification type code of the traveler notification.\n " modifiedUserKey: type: - string - 'null' description: "The modified user key.\n " modifiedDate: type: - string - 'null' description: "The date and time the object was modified.\n " format: date-time name: type: - string - 'null' description: "The name of the traveler notification.\n " deliveryMethods: type: - array - 'null' description: "The list of delivery methods for the traveler notification.\n " items: $ref: '#/components/schemas/TravelerNotificationDeliveryMethod' PhoneType: type: object description: "The phone type.\n " additionalProperties: false required: - phoneTypeCode properties: phoneTypeCode: type: string description: "The type code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 minLength: 1 name: type: - string - 'null' description: "The Name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "Is InActive.\n " type: description: "The enum value.\n " $ref: '#/components/schemas/PhoneNumberType' ContactType: type: object description: "The booking contact type.\n " additionalProperties: false required: - contactTypeCode properties: contactTypeCode: type: string description: "The type code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 minLength: 1 inActive: type: boolean description: "The in active.\n " name: type: - string - 'null' description: "The name of the type.\n " maxLength: 64 minLength: 0 IJsonResponseOfTimeZone: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/TimeZone' 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' StationDetail: type: object description: "Defines station details.\n " additionalProperties: false properties: categories: type: - array - 'null' description: "The station categories by category code. If empty all categories are supported.\nPlease note that this should be a list of chars and not a list of strings.\n " items: type: string maxLength: 1 feeZones: type: - array - 'null' description: "The fee zones by code.\n " items: type: string IJsonResponseOfIListOfSsrRestrictionResult: 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/SsrRestrictionResult' 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' RegularExpressionPolicy: type: object description: "The model describing regular expression policies for a string.\n " additionalProperties: false required: - policy properties: policy: type: string description: "The regular expression policy that will be evaluated.\n " maxLength: 128 minLength: 0 description: type: - string - 'null' description: "The policy description.\n " maxLength: 256 minLength: 0 IJsonResponseOfIListOfEnumResource: 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/EnumResource' 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' Carrier: type: object description: "The carrier model.\n " additionalProperties: false required: - carrierCode - carrierInfo - carrierName - carrierShortName - phone - url properties: carrierCode: type: string description: "The carrier code for this carrier.\n " maxLength: 3 minLength: 2 carrierInfo: type: string description: "The carrier info for this carrier.\n " maxLength: 60 minLength: 0 carrierName: type: string description: "The carrier name for this carrier.\n " maxLength: 64 minLength: 0 carrierShortName: type: string description: "The carrier short name for this carrier.\n " maxLength: 32 minLength: 0 carrierType: type: - string - 'null' description: "The carrier type for this carrier.\nPlease note that this should be a char and not a string.\n " maxLength: 1 eTicketIndicator: type: boolean description: "The e ticket indicator for this carrier.\n " inventoryIndicator: type: boolean description: "The inventory indicator for this carrier\n " phone: type: string description: "The phone number for this carrier.\n " maxLength: 20 minLength: 0 url: type: string description: "The Url for this carrier.\n " maxLength: 2048 minLength: 0 baggageIndicator: type: - string - 'null' description: "The baggage indicator for this carrier.\nPlease note that this should be a char and not a string.\n " maxLength: 1 iataAccountingCode: type: - string - 'null' description: "The numerical IATA accounting code for this carrier.\n " FareType: type: object description: "The fare type model.\n " additionalProperties: false required: - fareTypeCode properties: fareTypeCode: type: string description: "The fare type code.\n " minLength: 1 name: type: - string - 'null' description: "The name.\n " inActive: type: boolean description: "Is active.\n " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes endpoint to verify role based access instead.\n " IJsonResponseOfIListOfSingleSignOnProvider: 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/SingleSignOnProvider' 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' IJsonResponseOfIListOfTravelerNotificationDeliveryMethod: 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/TravelerNotificationDeliveryMethod' 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' IJsonResponseOfTitle: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Title' 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' IJsonResponseOfPostalCode: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PostalCode' 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' FeeApplication: type: integer description: "Enumeration representing how and where fees are to be applied.\n \n\n0 = Pnr\n1 = TravelComponent\n2 = EachPassenger\n3 = EachPassengerTravelComponent\n4 = SpecifyPassenger\n5 = AllPaxCheckingBagsTogether\n6 = PerBookingNoLimit" x-enumNames: - Pnr - TravelComponent - EachPassenger - EachPassengerTravelComponent - SpecifyPassenger - AllPaxCheckingBagsTogether - PerBookingNoLimit enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 IJsonResponseOfSeatPropertyType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SeatPropertyType' 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' IssuanceReason: type: object description: "The issuance reason model.\n " additionalProperties: false required: - issuanceReasonCode properties: issuanceReasonCode: type: string description: "The reason code.\n " maxLength: 4 minLength: 0 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The in active.\n " IJsonResponseOfIListOfAddressType: 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/AddressType' 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' Ssr: type: object description: "The sell service request (SSR) model.\n " additionalProperties: false properties: ssrCode: type: - string - 'null' description: "The Ssr code.\n " maxLength: 4 minLength: 1 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 1 feeCode: type: - string - 'null' description: "The fee code.\n " maxLength: 6 minLength: 0 ssrNestCode: type: - string - 'null' description: "The Ssr nest code.\n " maxLength: 4 minLength: 0 traceQueueCode: type: - string - 'null' description: "The trace queue code.\n " maxLength: 6 minLength: 0 ssrType: description: "The Ssr type.\n " $ref: '#/components/schemas/SsrType' inActive: type: boolean description: "The in active.\n " unitValue: type: integer description: "The unit value.\n " limitPerPassenger: type: integer description: "The limit per passenger.\n " maximum: 32767.0 minimum: 0.0 boardingZone: type: integer description: "The boarding zone.\n " maximum: 99.0 minimum: 0.0 allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes endpoint to verify role based access instead.\n " seatMapCode: type: - string - 'null' description: "The seat map code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 seatRestriction: description: "The seat restriction.\n " $ref: '#/components/schemas/SeatRestriction' ruleSetName: type: - string - 'null' description: "The rule set name.\n " ServiceBundleType: type: integer description: "Defines the types for bundles.\n \n\n0 = Included\n1 = AddOn" x-enumNames: - Included - AddOn enum: - 0 - 1 IJsonResponseOfDocumentType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/DocumentType' 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' IJsonResponseOfPromotionSettingType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PromotionSettingType' 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' DeductionType: type: integer description: "Enumeration representing the deduction type to be applied to fees/taxes.\n \n\n0 = All\n1 = First\n2 = Last\n3 = ExceptForFirst\n4 = ExceptForLast\n5 = None" x-enumNames: - All - First - Last - ExceptForFirst - ExceptForLast - None enum: - 0 - 1 - 2 - 3 - 4 - 5 CreateStationRequest: type: object description: "Defines the create station request.\n " additionalProperties: false required: - inActive - fullName - shortName - currencyCode - cultureCode - latitude - longitude - zoneCode - subZoneCode - countryCode - cityCode - timeZoneCode - weightType - stationCode properties: inActive: type: boolean description: "The flag indicating if the station is inactive.\n " icaoCode: type: - string - 'null' description: "The International Civil Aviation Organization (ICAO) code for the station.\n " maxLength: 4 minLength: 0 fullName: type: string description: "The full display name.\n " maxLength: 64 minLength: 0 shortName: type: string description: "The short display name.\n " maxLength: 32 minLength: 0 macCode: type: - string - 'null' description: "The MAC (Multiple Airport Code) code.\n " maxLength: 3 minLength: 0 currencyCode: type: string description: "The default currency code.\n " maxLength: 3 minLength: 0 conversionCurrencyCode: type: - string - 'null' description: "The configured conversion currency code.\n " maxLength: 3 minLength: 0 cultureCode: type: string description: "The culture code.\n " maxLength: 17 minLength: 0 stationClass: type: string description: "The configured class.\nPlease note that this should be a char and not a string.\n " maxLength: 1 latitude: type: string description: "The coordinates of the station.\n " maxLength: 10 minLength: 0 longitude: type: string description: "The coordinates of the station.\n " maxLength: 11 minLength: 0 zoneCode: type: string description: "The geographical location code (i.e. North America, Europe).\n " maxLength: 2 minLength: 0 subZoneCode: type: string description: "The sub zone code based on the geographical location (i.e. USA, Canada).\n " maxLength: 3 minLength: 0 countryCode: type: string description: "The country code the station exists in.\n " maxLength: 2 minLength: 0 provinceStateCode: type: - string - 'null' description: "The province or state the station exists in.\n " maxLength: 3 minLength: 0 cityCode: type: string description: "The city the station exists in.\n " maxLength: 3 minLength: 0 timeZoneCode: type: string description: "The configured timezone of the station.\n " maxLength: 4 minLength: 0 thirdPartyControlled: type: boolean description: "The flag indicating if the station is controlled via a third party.\n " weightType: description: "The configured weight units of measurement.\n " $ref: '#/components/schemas/WeightType' stationCode: type: string description: "The station unique code.\n " maxLength: 3 minLength: 3 IJsonResponseOfIListOfDocumentType: 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/DocumentType' 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' IJsonResponseOfSsrNest: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SsrNest' 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' IJsonResponseOfCulture: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Culture' 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' 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 NotificationContentType: type: integer description: "Represents the notification content format type.\n \n\n0 = XML\n1 = JSON" x-enumNames: - XML - JSON enum: - 0 - 1 IJsonResponseOfSsr: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Ssr' 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' IJsonResponseOfIListOfNotificationDeliveryMethod: 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/NotificationDeliveryMethod' 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' IJsonResponseOfIListOfPassengerType: 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/PassengerType' 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' IJsonResponseOfPrinter: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Printer' 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' 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 FareSurcharge: type: object description: "The fare surcharge model.\n " additionalProperties: false properties: fareSurchargeCode: type: - string - 'null' description: "The fare surcharge code.\n " name: type: - string - 'null' description: "The fare surcharge name.\n " displayCode: type: - string - 'null' description: "The display code.\n " defaultCurrencyCode: type: - string - 'null' description: "The default currency code.\n " taxApplication: description: "The tax application.\n " $ref: '#/components/schemas/TaxApplication' fareSurchargeAmounts: type: - array - 'null' description: "The fare surcharge amount list.\n " items: $ref: '#/components/schemas/FareSurchargeAmount' inActive: type: boolean description: "The inactive flag.\n " percent: type: number description: "The percent.\n " format: decimal ExternalSystem: type: object description: "The external system model.\n " additionalProperties: false properties: systemCode: type: - string - 'null' description: "The code for this external system.\n " maxLength: 3 minLength: 0 name: type: - string - 'null' description: "The name for this external system.\n " maxLength: 64 minLength: 0 IJsonResponseOfCarrier: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Carrier' 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' ClassOfService: type: object description: "The class of service model.\n " additionalProperties: false properties: classOfServiceCode: type: - string - 'null' description: "The class of service code.\n " maxLength: 8 minLength: 0 name: type: - string - 'null' description: "The Name.\n " maxLength: 64 minLength: 0 shortName: type: - string - 'null' description: "The short name.\n " maxLength: 32 minLength: 0 nonRevenue: type: boolean description: "The non revenue.\n " traceQueueCode: type: - string - 'null' description: "The trace queue code.\n " maxLength: 6 minLength: 0 gdsBookingOnly: type: boolean description: "The GDS booking only.\n " upgrade: type: boolean description: "Indicates if the class of service is used for upgrades.\n " inActive: type: boolean description: "The in active.\n " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes endpoint to verify role based access instead.\n " standByAllowed: type: boolean description: "The stand by allowed.\n " seatGroup: type: integer description: "The seat group.\n " downgrade: type: boolean description: "Indicates if the class of service is used for downgrades.\n " IJsonResponseOfIListOfDomain: 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/Domain' 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' TimeZone: type: object description: "The timezone model.\n " additionalProperties: false required: - timeZoneCode properties: inActive: type: boolean description: "Gets or sets the inactive flag for this time zone.\n " name: type: - string - 'null' description: "Gets or sets the name of this time zone.\n " maxLength: 64 minLength: 0 standardVariation: type: integer description: "Gets or sets the standard variation of this time zone\n " timeZoneCode: type: string description: "Gets or sets the time zone code of this time zone.\n " maxLength: 4 minLength: 4 timeZoneVariations: type: - array - 'null' description: "Gets or sets a list of Time zone variations associated with this time zone.\n " items: $ref: '#/components/schemas/TimeZoneVariation' City: type: object description: "The city model.\n " additionalProperties: false properties: cityCode: type: - string - 'null' description: "Gets or sets the code for this city.\n " maxLength: 3 minLength: 1 countryCode: type: - string - 'null' description: "Gets or sets the country code for this city\n " maxLength: 2 minLength: 1 inActive: type: boolean description: "Gets or sets the inactive flag for this city.\n " name: type: - string - 'null' description: "Gets or sets the name for this city\n " maxLength: 64 minLength: 0 provinceStateCode: type: - string - 'null' description: "Gets or sets the province/state code for this city.\n " maxLength: 3 minLength: 1 shortName: type: - string - 'null' description: "Gets or sets the short name for this city.\n " maxLength: 32 minLength: 0 ExternalRate: type: object description: "External rate model.\n " additionalProperties: false properties: rateId: type: - string - 'null' description: "The id for this external rate.\n " quotedCurrency: type: - string - 'null' description: "The quoted currency for this external rate.\n " maxLength: 3 minLength: 0 collectedCurrency: type: - string - 'null' description: "The collected currency for this external rate.\n " maxLength: 3 minLength: 0 exchangeRate: type: number description: "The exchange rate for this external rate.\n " format: decimal Coordinate: type: object description: "The defined coordinates of a location.\n " additionalProperties: false properties: latitude: type: - string - 'null' description: "The locations latitude.\n " longitude: type: - string - 'null' description: "The locations longitude.\n " IJsonResponseOfDelay: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Delay' 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' IJsonResponseOfIListOfSeatPropertyType: 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/SeatPropertyType' 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' Exception: type: object additionalProperties: false properties: Message: type: string InnerException: $ref: '#/components/schemas/Exception' Source: type: - string - 'null' StackTrace: type: - string - 'null' ContentType: type: integer description: "Content Type enumeration.\n \n\n0 = GeneralReference\n1 = News\n2 = ConsoleHelp\n3 = FareRuleReference\n4 = ReviewWithCustomer\n8 = Image\n9 = PromotionReference\n10 = SubscriptionReference" x-enumNames: - GeneralReference - News - ConsoleHelp - FareRuleReference - ReviewWithCustomer - Image - PromotionReference - SubscriptionReference enum: - 0 - 1 - 2 - 3 - 4 - 8 - 9 - 10 IJsonResponseOfIListOfCulture: 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/Culture' 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' TravelComponent: type: integer description: "Enumeration for a travel component type.\n \n\n0 = Unknown\n1 = Itinerary\n2 = Trip\n3 = Journey\n4 = Segment\n5 = Leg\n6 = SpecificLeg\n9 = ItineraryWithJourneySalesDate\n10 = TripWithJourneySalesDate\n11 = JourneyWithBookingSalesDate\n12 = JourneyWithJourneySalesDate\n13 = SegmentWithJourneySalesDate\n14 = LegWithJourneySalesDate\n15 = Fare\n16 = LegWithConfirmingSalesDate\n17 = SegmentWithConfirmingSalesDate\n18 = JourneyWithConfirmingSalesDate" x-enumNames: - Unknown - Itinerary - Trip - Journey - Segment - Leg - SpecificLeg - ItineraryWithJourneySalesDate - TripWithJourneySalesDate - JourneyWithBookingSalesDate - JourneyWithJourneySalesDate - SegmentWithJourneySalesDate - LegWithJourneySalesDate - Fare - LegWithConfirmingSalesDate - SegmentWithConfirmingSalesDate - JourneyWithConfirmingSalesDate enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 Zonev2: type: object description: "The version two of the zone model.\n " additionalProperties: false required: - areaCode - zoneCode properties: areaCode: type: string description: "Gets or sets the area code of this zone.\n " maxLength: 3 minLength: 1 name: type: - string - 'null' description: "Gets or sets the name of this zone.\n " maxLength: 64 minLength: 0 zoneCode: type: string description: "Gets or sets the zone code of this zone.\n " maxLength: 2 minLength: 1 IJsonResponseOfMac: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Mac' 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' IJsonResponseOfListOfMarketv2: 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/Marketv2' 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' IJsonResponseOfIListOfCustomerProgram: 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/CustomerProgram' 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' IJsonResponseOfIListOfStandByPriority: 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/StandByPriority' 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' IJsonResponseOfIListOfMac: 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/Mac' 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' RequiredType: type: integer description: "This enum represents the state of a payment field.\n \n\n0 = Required\n1 = Optional\n2 = NotAllowed" x-enumNames: - Required - Optional - NotAllowed enum: - 0 - 1 - 2 IJsonResponseOfCustomerProgramv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CustomerProgramv2' 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' IJsonResponseOfZonev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Zonev2' 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' CustomerProgramSetting: type: object description: "The customer program setting.\n " additionalProperties: false properties: programCode: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 programLevel: type: - string - 'null' description: "The program level.\n " maxLength: 3 minLength: 0 settingCode: type: - string - 'null' description: "The setting code.\n " maxLength: 16 minLength: 0 sequenceNumber: type: integer description: "The sequence number.\n " maximum: 32767.0 minimum: 0.0 settingValue: type: - string - 'null' description: "The setting value.\n " maxLength: 64 minLength: 0 IJsonResponseOfResourcePostalCodeResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ResourcePostalCodeResponse' 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' IJsonResponseOfProvinceState: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ProvinceState' 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' Delay: type: object description: "The delay model.\n " additionalProperties: false properties: delayCode: type: - string - 'null' description: "The delay code.\n " delayType: description: "The delay type.\n " $ref: '#/components/schemas/DelayType' name: type: - string - 'null' description: "The Name.\n " inActive: type: boolean description: "The InActive of Delay.\n " FeeOptionMode: type: integer description: "Enumeration for different modes for fee options.\n \n\n0 = Default\n1 = All\n2 = LowestCost\n3 = HighestCost" x-enumNames: - Default - All - LowestCost - HighestCost enum: - 0 - 1 - 2 - 3 EnumResource: type: object description: "Provide localization information about an enumeration.\n " additionalProperties: false required: - code properties: code: type: integer description: "The unique property code.\n " description: type: - string - 'null' description: "The description.\n " FareDiscount: type: object description: "The fare discount model.\n " additionalProperties: false properties: fareDiscountCode: type: - string - 'null' description: "The fare discount code.\n " name: type: - string - 'null' description: "The fare discount name.\n " fareDiscountAmounts: type: - array - 'null' description: "The fare discount amounts.\n " items: $ref: '#/components/schemas/FareDiscountAmount' inActive: type: boolean description: "The inactive flag.\n " discountPercent: type: number description: "The discount percent.\n " format: decimal IJsonResponseOfCustomerProgramLevel: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CustomerProgramLevel' 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' ContentDataType: type: integer description: "Defines the content data type enumeration.\n \n\n0 = Default\n1 = Text\n2 = RichTextFormat\n3 = ImageJpg\n4 = ImageGif\n5 = ImageBmp\n6 = ImagePng\n7 = WordDoc\n8 = Html\n9 = Pdf\n10 = Uri\n11 = WordDocx\n-1 = Unmapped" x-enumNames: - Default - Text - RichTextFormat - ImageJpg - ImageGif - ImageBmp - ImagePng - WordDoc - Html - Pdf - Uri - WordDocx - Unmapped enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - -1 ShoppingAttributeType: type: integer description: "Enumeration for shopping attribute types.\n \n\n0 = None\n1 = Destination\n2 = Region\n3 = Event" x-enumNames: - None - Destination - Region - Event enum: - 0 - 1 - 2 - 3 IJsonResponseOfShoppingAttributeGroup: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ShoppingAttributeGroup' 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' IJsonResponseOfExternalRate: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ExternalRate' 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' IJsonResponseOfCustomerProgram: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/CustomerProgram' 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' DocumentGroup: type: integer description: "The document grouping enumeration.\n \n\n0 = Unknown\n1 = AlienRegistrationCard\n2 = PermanentResidentCard\n3 = FacilitationDocument\n4 = InsPass\n5 = MilitaryId\n6 = Passport\n7 = ReEntryPermit\n8 = CreditCard\n9 = TravelVisa\n10 = OaFrequentFlyer\n11 = ParoleLetter\n12 = NoticeOfAction\n13 = TransportationLetter\n14 = BorderCrossingCard\n15 = PilotLicense\n16 = UsNaturalizationCertificate\n17 = RefugeeTravelDocument\n18 = GovernmentId\n19 = DriversLicense\n20 = RedressNumber\n21 = KnownTravelerId\n22 = FormOfId\n23 = Nexus\n24 = SecondaryExempt" x-enumNames: - Unknown - AlienRegistrationCard - PermanentResidentCard - FacilitationDocument - InsPass - MilitaryId - Passport - ReEntryPermit - CreditCard - TravelVisa - OaFrequentFlyer - ParoleLetter - NoticeOfAction - TransportationLetter - BorderCrossingCard - PilotLicense - UsNaturalizationCertificate - RefugeeTravelDocument - GovernmentId - DriversLicense - RedressNumber - KnownTravelerId - FormOfId - Nexus - SecondaryExempt enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 Title: type: object description: "Defines the title that can be associated to an individual or object (passenger, person, etc.).\n " additionalProperties: false properties: titleKey: type: - string - 'null' description: "The unique identifier of the title.\n " maxLength: 6 minLength: 1 description: type: - string - 'null' description: "Short description about the title.\n " maxLength: 128 minLength: 0 gender: description: "The binary gender associated with the title.\n " $ref: '#/components/schemas/Gender' weightCategory: description: "The weight category.\n " $ref: '#/components/schemas/WeightCategory' inActive: type: boolean description: "Indicates if the title is active or inactive.\n " declaredGender: type: - string - 'null' description: "The non-binary gender associated with the title.\n " FeeRule: type: object description: "Fee rule model.\n " additionalProperties: false properties: number: type: integer description: "Gets or sets the fee option number for this fee rule.\n " maximum: 32767.0 minimum: 0.0 ruleNumber: type: integer description: "Gets or sets the fee rule number for this fee rule.\n " maximum: 32767.0 minimum: 0.0 properties: type: - array - 'null' description: "Gets or sets the list of fee rule properties for this fee rule.\n " items: $ref: '#/components/schemas/FeeRuleProperty' operator: description: "Gets or sets the fee rule operator for this fee rule.\n " $ref: '#/components/schemas/FeeRuleOperator' Mac: type: object description: "The MAC station model defines areas of related stations by region. //todo: Document and expand the MAC acronym\n " additionalProperties: false required: - macCode - name properties: inActive: type: boolean description: "The inactive flag for this MAC station.\n " macCode: type: string description: "The code for this MAC station.\n " maxLength: 3 minLength: 1 macStations: type: - array - 'null' description: "The stations associated with this MAC.\n " items: type: string name: type: string description: "The name for this MAC.\n " maxLength: 64 minLength: 1 IJsonResponseOfIListOfTailNumberInventoryItem: 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/TailNumberInventoryItem' 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' IJsonResponseOfBaggageType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/BaggageType' 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' DccType: type: integer description: "Dynamic Currency Conversion (DCC) types.\n \n\n0 = None\n1 = ZeroRate\n2 = FullAmount" x-enumNames: - None - ZeroRate - FullAmount enum: - 0 - 1 - 2 IJsonResponseOfIListOfStationCategory: 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/StationCategory' 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' IJsonResponseOfResourceContentItem: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ResourceContentItem' 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' StationLocationDetails: type: object description: "Defines the station location details.\n " additionalProperties: false properties: coordinates: description: "The coordinates of the station.\n " $ref: '#/components/schemas/Coordinate' zoneCode: type: - string - 'null' description: "The geographical location code (i.e. North America, Europe).\n " subZoneCode: type: - string - 'null' description: "The sub zone code based on the geographical location (i.e. USA, Canada).\n " countryCode: type: - string - 'null' description: "The country code the station exists in.\n " provinceStateCode: type: - string - 'null' description: "The province or state the station exists in.\n " cityCode: type: - string - 'null' description: "The city the station exists in.\n " timeZoneCode: type: - string - 'null' description: "The configured timezone of the station.\n " thirdPartyControlled: type: boolean description: "The flag indicating if the station is controlled via a third party.\n " customsRequiredForCrew: type: boolean description: "The flag indicating if customs is required for crew members.\n " weightType: description: "The stations configured weight units of measurement.\n " $ref: '#/components/schemas/WeightType' IJsonResponseOfPassengerDiscount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerDiscount' 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' IJsonResponseOfNonBinaryGender: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/NonBinaryGender' 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' IJsonResponseOfDomain: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Domain' 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' MarketRoute: type: object description: "Defines a market route.\n " additionalProperties: false properties: arrivalStation: type: - string - 'null' description: "The route arrival station.\n " maxLength: 3 minLength: 3 departureStation: type: - string - 'null' description: "The route departure station.\n " maxLength: 3 minLength: 3 connectionMarketSegments: type: - array - 'null' description: "The list of segments that comprise this route, in order.\n " items: $ref: '#/components/schemas/MarketSegment' IJsonResponseOfRoleSettingType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/RoleSettingType' 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' EmailType: type: object description: "The email type.\n " additionalProperties: false required: - emailTypeCode properties: emailTypeCode: type: string description: "The email type code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 minLength: 1 name: type: - string - 'null' description: "The type name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The InActive.\n " dataSchema: type: - string - 'null' description: "The data schema.\n " maxLength: 2147483647 minLength: 0 IJsonResponseOfIListOfFeeDetail: 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/FeeDetail' 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' IJsonResponseOfIListOfZonev2: 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/Zonev2' 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' MarketSegment: type: object description: "The market model.\n " additionalProperties: false properties: departureStation: type: - string - 'null' description: "The departure station of the segment.\n " maxLength: 3 minLength: 3 arrivalStation: type: - string - 'null' description: "The arrival station of the segment.\n " maxLength: 3 minLength: 3 segmentNumber: type: integer description: "The sequence number for this segment.\n " IJsonResponseOfSsrGroup: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SsrGroup' 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' SsrType: type: integer description: "SsrType enumeration.\n \n\n0 = Standard\n1 = Infant\n2 = Meal\n3 = BaggageAllowance\n4 = TravelLineMeal" x-enumNames: - Standard - Infant - Meal - BaggageAllowance - TravelLineMeal enum: - 0 - 1 - 2 - 3 - 4 IJsonResponseOfPassengerType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PassengerType' 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 IJsonResponseOfIListOfFareSurcharge: 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/FareSurcharge' 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' FareDiscountAmount: type: object description: "The fare discount amount model.\n " additionalProperties: false properties: fareDiscountCode: type: - string - 'null' description: "The fare discount code.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " discountAmount: type: number description: "The discount amount.\n " format: decimal IJsonResponseOfIListOfPassengerDiscount: 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/PassengerDiscount' 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' IJsonResponseOfIListOfFareType: 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/FareType' 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' 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 SeatPropertyValue: type: object description: "Represents a possible value of a seat property type.\n " additionalProperties: false properties: code: type: - string - 'null' description: "Seat property value code.\n " name: type: - string - 'null' description: "The name of a seat property value.\n " IJsonResponseOfIListOfBundleRule: 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/BundleRule' 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' IJsonResponseOfFareSurcharge: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/FareSurcharge' 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' IJsonResponseOfStandByPriority: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/StandByPriority' 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' BundleSet: type: object description: "The bundle set model.\n " additionalProperties: false properties: bundleSetCode: type: - string - 'null' description: "The service bundle code.\n " maxLength: 4 minLength: 0 name: type: - string - 'null' description: "The bundle set name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "Indicates if the set is inactive or not.\n " bundleCodes: type: - array - 'null' description: "The collection of bundle codes associated with the bundle set.\n " items: type: string PassengerDiscountType: type: integer description: "Passenger discount type enumeration.\n \n\n0 = Default\n1 = Regular\n2 = Loyalty" x-enumNames: - Default - Regular - Loyalty enum: - 0 - 1 - 2 TravelClass: type: object description: "This model represents the passenger summary info per cabin.\n " additionalProperties: false required: - name properties: travelClassCode: type: - string - 'null' description: "Gets or sets the code for this travel class.\n " name: type: string description: "Gets or sets the name for this travel class.\n " maxLength: 64 minLength: 0 cabinOfServiceCode: type: - string - 'null' description: "Gets or sets the cabin of service code for this travel class.\n " systemControlled: type: boolean description: "Gets or sets the system controlled flag for this travel class.\n " inActive: type: boolean description: "Gets or sets the inactive flag for this travel class.\n " IJsonResponseOfLocation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Location' 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' IJsonResponseOfIListOfMessageType: 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/MessageType' 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' Suffix: type: object description: "The suffix model.\n " additionalProperties: false required: - suffixCode properties: suffixCode: type: string description: "The suffix code.\n " minLength: 1 name: type: - string - 'null' description: "The name.\n " inActive: type: boolean description: "Is InActive.\n " SsrRestrictionResult: type: object description: "The SSR Restriction Result model.\n " additionalProperties: false properties: inActive: type: boolean description: "Gets or sets the inactive flag for this model.\n " ssrRestrictionResultCode: type: - string - 'null' description: "Gets or sets the code for this model\n " maxLength: 32 minLength: 0 name: type: - string - 'null' description: "Gets or sets the name for this model.\n " maxLength: 64 minLength: 0 IJsonResponseOfIListOfCommissionRate: 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/CommissionRate' 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' IJsonResponseOfFareType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/FareType' 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' 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 BookingPaymentField: type: integer description: "This enum represents payment field categories.\n \n\n0 = Miscellaneous\n1 = AccountNumber\n2 = Amount\n3 = ExpirationDate\n4 = CurrencyCode\n5 = PaymentText\n6 = PrepaidApprovalCode\n7 = Deposit" x-enumNames: - Miscellaneous - AccountNumber - Amount - ExpirationDate - CurrencyCode - PaymentText - PrepaidApprovalCode - Deposit enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 IJsonResponseOfStationDetail: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/StationDetail' 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' PassengerDiscount: type: object description: "The passenger discount model.\n " additionalProperties: false properties: passengerDiscountCode: type: - string - 'null' description: "The passenger discount code.\n " maxLength: 4 minLength: 1 name: type: - string - 'null' description: "The Name.\n " maxLength: 64 minLength: 0 passengerDiscountType: description: "The passenger discount type.\n " $ref: '#/components/schemas/PassengerDiscountType' inActive: type: boolean description: "The in active.\n " allowed: type: boolean description: "The allowed.\n " IJsonResponseOfIListOfLocation: 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/Location' 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' PersonInformationType: type: object description: "The person information type model.\n " additionalProperties: false required: - personInformationTypeCode properties: personInformationTypeCode: type: string description: "The person information type code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 minLength: 1 name: type: - string - 'null' description: "The name of the type.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "Is in-active.\n " schema: type: - string - 'null' description: "The data schema of person info type.\n " maxLength: 2147483647 minLength: 0 TailNumberInventoryItem: type: object description: "The tail number inventory item model.\n " additionalProperties: false properties: tailNumber: type: - string - 'null' description: "The tail number.\n " maxLength: 10 minLength: 0 equipmentType: type: - string - 'null' description: "The associated equipment type.\n " maxLength: 3 minLength: 0 equipmentTypeSuffix: type: - string - 'null' description: "The associated equipment type suffix.\n " maxLength: 3 minLength: 0 BundleRule: type: object description: "The bundle rule model.\n " additionalProperties: false properties: bundleRuleCode: type: - string - 'null' description: "The bundle rule code.\n " maxLength: 4 minLength: 0 name: type: - string - 'null' description: "The bundle rule name.\n " maxLength: 64 minLength: 0 Culture: type: object description: "Defines a culture code.\n " additionalProperties: false required: - cultureCode properties: cultureCode: type: string description: "The unique code for the culture.\n " maxLength: 17 minLength: 1 name: type: - string - 'null' description: "The display name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The flag indicating if the resource is inactive.\n " IJsonResponseOfStation: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Station' 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' TaxApplication: type: integer description: "Enumeration representing how taxes are applied to a fee.\n \n\n0 = Unknown\n1 = Taxable\n2 = TaxableLocal\n3 = NonTaxable\n4 = NonTaxableApplyToBaseFareOnly\n5 = TaxableByTrip\n6 = TaxableByItinerary" x-enumNames: - Unknown - Taxable - TaxableLocal - NonTaxable - NonTaxableApplyToBaseFareOnly - TaxableByTrip - TaxableByItinerary enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 IJsonResponseOfClassOfService: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ClassOfService' 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' ValueType: type: integer description: "This enum represents the value type of an input box.\n \n\n0 = Unknown\n1 = String\n2 = UpperCaseString\n3 = Numeric\n4 = Alphanumeric\n5 = Amount\n6 = Date\n7 = Mod10\n8 = Name\n9 = Address\n10 = State\n11 = Zip\n12 = Country\n13 = City\n14 = Boolean\n15 = Email" x-enumNames: - Unknown - String - UpperCaseString - Numeric - Alphanumeric - Amount - Date - Mod10 - Name - Address - State - Zip - Country - City - Boolean - Email enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 IJsonResponseOfIListOfTitle: 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/Title' 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' SsrNest: type: object description: "The SSR nest model.\n " additionalProperties: false properties: ssrNestCode: type: - string - 'null' description: "The SSR nest code.\n " maxLength: 4 minLength: 0 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 1 inActive: type: boolean description: "The in active.\n " ssrs: type: - array - 'null' description: "The SSR.\n " items: $ref: '#/components/schemas/Ssr' Marketv2: type: object description: "The market model, version 2.\n " additionalProperties: false required: - locationCode - travelLocationCode properties: locationCode: type: string description: "The starting location code for this market.\n " maxLength: 3 minLength: 0 earliestCheckInFrom: type: integer description: "The earliest check in from travel location for this market.\n " format: int32 earliestCheckInTo: type: integer description: "The earliest check in to travel location for this market.\n " format: int32 inActive: type: boolean description: "The inactive flag for this market.\n " includesTaxesAndFees: description: "The directions where taxes and fees are included in this market.\n " $ref: '#/components/schemas/Directionality' latestCheckInFrom: type: integer description: "The latest check in from travel location for this market.\n " format: int32 latestCheckInTo: type: integer description: "The latest check in to travel location for this market.\n " format: int32 locationType: description: "The location type of the starting location for this market.\n " $ref: '#/components/schemas/MarketLocationType' travelLocationCode: type: string description: "The ending location code for this market.\n " maxLength: 3 minLength: 0 travelLocationType: description: "The location type of the ending location for this market.\n " $ref: '#/components/schemas/MarketLocationType' travelLocationsRequired: description: "The market rules for requiring travel documents for this market.\n " $ref: '#/components/schemas/TravelLocationsRequired' ReminderTime: type: object description: "The reminder time for a notification timed event.\n " additionalProperties: false properties: type: description: "The notification timed event type.\n " $ref: '#/components/schemas/NotificationTimedEventType' times: type: - array - 'null' description: "The list of acceptable reminder times.\n " items: type: integer format: int32 TravelerNotificationDeliveryMethod: type: object description: "Traveler notification delivery method model.\n " additionalProperties: false properties: createdUserKey: type: - string - 'null' description: "The created user key.\n " createdDate: type: - string - 'null' description: "The date and time the object was created.\n " format: date-time notificationTypeCode: type: - string - 'null' description: "Notification type code of the traveler notification.\n " modifiedUserKey: type: - string - 'null' description: "The modified user key.\n " modifiedDate: type: - string - 'null' description: "The date and time the object was modified.\n " format: date-time allowForAnonymous: type: boolean description: "Gets or sets if the traveler notification is allowed for anonymous user.\n " allowForCustomer: type: boolean description: "Gets or sets if the traveler notification is allowed for customer.\n " allowForPassenger: type: boolean description: "Gets or sets if the traveler notification is allowed for passenger.\n " deliveryMethodCode: type: - string - 'null' description: "Delivery method code of the traveler notification.\n " inActive: type: boolean description: "Gets or sets the inactive flag.\n " programCode: type: - string - 'null' description: "The program code.\n " programLevel: type: - string - 'null' description: "The program level.\n " FeeDetail: type: object description: "Fee detail model.\n " additionalProperties: false properties: number: type: integer description: "Gets or sets the fee option number of this fee option.\n " maximum: 32767.0 minimum: 0.0 feeRules: type: - array - 'null' description: "Gets or sets the fee rules for this fee option.\n " items: $ref: '#/components/schemas/FeeRule' name: type: - string - 'null' description: "Gets or sets the name for this fee option.\n " maxLength: 64 minLength: 0 regionFees: type: - array - 'null' description: "Gets or sets the region fees for this fee option.\n " items: $ref: '#/components/schemas/RegionFee' taxApplicationOverride: description: "Gets or sets the override of how to apply the taxes.\n " $ref: '#/components/schemas/TaxApplication' travelComponentOverride: description: "Gets or sets the override for the travel component.\n " $ref: '#/components/schemas/TravelComponent' useOverrides: type: boolean description: "Gets or sets the flag for using the overrides.\n " feeApplicationOverride: description: "Gets or sets the override for where to apply this fee option.\n " $ref: '#/components/schemas/FeeApplication' WeightCategory: type: integer description: "Defines the categories of adults by gender or specifies the passenger as a child. This is used for balance\ndeterminations.\n \n\n0 = Undefined\n1 = Male\n2 = Female\n3 = Child" x-enumNames: - Undefined - Male - Female - Child enum: - 0 - 1 - 2 - 3 IJsonResponseOfIListOfRoleSettingType: 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/RoleSettingType' 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' IJsonResponseOfIListOfMarketv2: 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/Marketv2' 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' ProvinceState: type: object description: "The province/state code model.\n " additionalProperties: false required: - provinceStateCode - countryCode properties: cities: type: - array - 'null' description: "Gets or sets the list of cities associated with this province/state\n " items: $ref: '#/components/schemas/City' provinceStateCode: type: string description: "Gets or sets the code of the province/state.\n " maxLength: 3 minLength: 1 name: type: - string - 'null' description: "Gets or sets the Name of the province/state.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "Gets or sets the inactive flag of the province/state.\n " countryCode: type: string description: "Gets or sets the country code of the province/state.\n " maxLength: 2 minLength: 1 StationCategory: type: object description: "The station category model.\n " additionalProperties: false properties: stationCategoryCode: type: string description: "The station category code.\nPlease note that this should be a char and not a string.\n " maxLength: 1 name: type: - string - 'null' description: "The name.\n " inActive: type: boolean description: "THe in active.\n " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes endpoint to verify role based access instead.\n " IJsonResponseOfIListOfSubZonev2: 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/SubZonev2' 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' CommissionRate: type: object description: "The commission rate model.\n " additionalProperties: false required: - commissionRateCode properties: commissionRateCode: type: string description: "The commission rate code.\n " maxLength: 8 minLength: 0 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The in active.\n " Department: type: object description: "The department model.\n " additionalProperties: false properties: departmentCode: type: - string - 'null' description: "The department code.\n " maxLength: 4 minLength: 0 name: type: - string - 'null' description: "The department name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The in active.\n " ResourceContentItem: type: object description: "Model representing a resource content item.\n " additionalProperties: false required: - contentId properties: contentId: type: integer description: "The content id.\n " format: int64 name: type: - string - 'null' description: "Name of the content\n " description: type: - string - 'null' description: "Description of the content.\n " cultureCode: type: - string - 'null' description: "Culture code of the data.\n " size: type: integer description: "Size in bytes of the data.\n " format: int64 type: description: "Specific content type.\n " $ref: '#/components/schemas/ContentType' dataType: description: "Content data type.\n " $ref: '#/components/schemas/ContentDataType' data: type: - string - 'null' description: "Data bytes.\n " format: byte QueueCategory: type: object description: "The Queue Category model.\n " additionalProperties: false properties: queueCategoryCode: type: - string - 'null' description: "The queue category code of queue category.\nPlease note that this should be a char and not a string.\n " maxLength: 1 name: type: - string - 'null' description: "The name of the queue category\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The InActive of QueueCategory.\n " allowed: type: boolean description: "The Allowed Class Of Service.\n " IJsonResponseOfIListOfAccountTransactionCode: 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/AccountTransactionCode' 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' RegionFilter: type: object description: "The region filter model.\n " additionalProperties: false properties: origin: description: "The details related to the region of origin for the bundle application.\n " $ref: '#/components/schemas/RegionIdentifier' destination: description: "The details related to the destination region for the bundle application.\n " $ref: '#/components/schemas/RegionIdentifier' IJsonResponseOfFareDiscount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/FareDiscount' 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' CustomerProgramLevel: type: object description: "The customer program level.\n " additionalProperties: false properties: programCode: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 programLevelCode: type: - string - 'null' description: "The program level.\n " maxLength: 3 minLength: 0 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 0 shortName: type: - string - 'null' description: "The short name.\n " maxLength: 32 minLength: 0 displayCode: type: - string - 'null' description: "The display code.\n " maxLength: 1 minLength: 0 rank: type: integer description: "The rank.\n " maximum: 32767.0 minimum: 0.0 inActive: type: boolean description: "The in active flag.\n " customerProgramSettings: type: - array - 'null' description: "The list of customer program settings.\n " items: $ref: '#/components/schemas/CustomerProgramSetting' PaymentRefundType: type: integer description: "Enum representing whether or not a payment can be refunded.\n \n\n0 = NotAllowed\n1 = LineItemLevel\n2 = AccountLevel\n3 = BookingLevel" x-enumNames: - NotAllowed - LineItemLevel - AccountLevel - BookingLevel enum: - 0 - 1 - 2 - 3 IJsonResponseOfEmailType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/EmailType' 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' IJsonResponseOfDepartment: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Department' 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' IJsonResponseOfIListOfQueueCategory: 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/QueueCategory' 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' IJsonResponseOfQueueCategory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/QueueCategory' 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' IJsonResponseOfIListOfTravelerNotification: 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/TravelerNotification' 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' Countryv2: type: object description: "Represents the country model, version two.\n " additionalProperties: false required: - countryCode - countryCode3C properties: countryCode: type: string description: "Represents the two-digit country code.\n " maxLength: 2 minLength: 1 countryCode3C: type: string description: "Represents the three-digit country code.\n " maxLength: 3 minLength: 1 cities: type: - array - 'null' description: "Gets or sets the list of cities in this country.\n " items: $ref: '#/components/schemas/City' defaultCurrencyCode: type: - string - 'null' description: "Gets or sets the default currency code of this country.\n " maxLength: 3 minLength: 1 hasProvinceStates: type: boolean description: "Gets or sets whether this country has province states.\n " inActive: type: boolean description: "Gets or sets whether this country is active.\n " name: type: - string - 'null' description: "Gets or sets the name of this country.\n " maxLength: 64 minLength: 0 provinceStates: type: - array - 'null' description: "Gets or sets the province states for this country.\n " items: $ref: '#/components/schemas/ProvinceState' IJsonResponseOfIListOfHotCardReason: 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/HotCardReason' 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' 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 " IJsonResponseOfArea: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Area' 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' RegionFee: type: object description: "Region fee model.\n " additionalProperties: false properties: controlLimit: type: integer description: "Gets or sets the control limit of this region fee.\n " countryCode: type: - string - 'null' description: "Gets or sets the country code of this region fee.\n " deducted: type: boolean description: "Gets or sets the deducted flag of this region fee.\n " deductionType: description: "Gets or sets the deduction type of this region fee.\n " $ref: '#/components/schemas/DeductionType' defaultCurrencyCode: type: - string - 'null' description: "Gets or sets the default currency code of this region fee.\n " maxLength: 3 minLength: 0 directionality: description: "Gets or sets the directionality of this region fee.\n " $ref: '#/components/schemas/Directionality' discontinueDate: type: - string - 'null' description: "Gets or sets the discontinue date of this region fee.\n " format: date-time feeOptionNumber: type: integer description: "Gets or sets the fee option number for this region fee.\n " ratePercent: type: number description: "Gets or sets the rate percent for this region fee.\n " format: decimal regionCode: type: - string - 'null' description: "Gets or sets the region code for this region fee.\n " maxLength: 5 minLength: 0 baggage: description: "Gets or sets the baggage for this region fee.\n " $ref: '#/components/schemas/RegionFeeBaggage' id: type: - integer - 'null' description: "Gets or sets the id for this region fee.\n " format: int64 regionRates: type: - array - 'null' description: "Gets or sets the list for region rates for this region fee.\n " items: $ref: '#/components/schemas/RegionRate' regionType: description: "Gets or sets the region type for this region fee.\n " $ref: '#/components/schemas/RegionType' releaseDate: type: - string - 'null' description: "Gets or sets the release date for this region fee.\n " format: date-time travelCountryCode: type: - string - 'null' description: "Gets or sets the travel country code for this region fee.\n " travelDiscontinueDate: type: - string - 'null' description: "Gets or sets the travel discount date for this region fee.\n " format: date-time travelRegionCode: type: - string - 'null' description: "Gets or sets the travel region code for this region.\n " maxLength: 5 minLength: 0 travelRegionType: description: "Gets or sets the travel region type for this region.\n " $ref: '#/components/schemas/RegionType' travelReleaseDate: type: - string - 'null' description: "Gets or sets the travel release date for this region.\n " format: date-time travelSegmentIndicator: description: "Gets or sets the travel segment indicator for this region.\n " $ref: '#/components/schemas/TravelSegmentIndicator' RefundState: type: integer description: "Enumeration representing the refund ui state.\n \n\n0 = Enabled\n1 = Disabled\n2 = Hidden" x-enumNames: - Enabled - Disabled - Hidden enum: - 0 - 1 - 2 IJsonResponseOfSingleSignOnProvider: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SingleSignOnProvider' 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' DelayType: type: integer description: "DelayType\n \n\n0 = Unknown\n1 = AirlineInternalCodes\n2 = Others\n3 = Schedules\n4 = PassengerAndBaggage\n5 = CargoAndMail\n6 = MailOnly\n7 = AircraftAndRampHandling\n8 = TechnicalAndAircraftEquipment\n9 = DamageToAircraft\n10 = EdpAutomatedEquipmentFailure\n11 = FlightOperationsAndCrewing\n12 = Weather\n13 = AirTrafficFlowManagement\n14 = AirportAndGovernmentalAuthorities\n15 = Reactionary\n16 = Miscellaneous" x-enumNames: - Unknown - AirlineInternalCodes - Others - Schedules - PassengerAndBaggage - CargoAndMail - MailOnly - AircraftAndRampHandling - TechnicalAndAircraftEquipment - DamageToAircraft - EdpAutomatedEquipmentFailure - FlightOperationsAndCrewing - Weather - AirTrafficFlowManagement - AirportAndGovernmentalAuthorities - Reactionary - Miscellaneous enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 NonBinaryGender: type: object description: "The non-binary genders defined in the system.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The unique gender code.\n " name: type: - string - 'null' description: "The gender name.\n " inActive: type: boolean description: "Indicates if the gender is active or not.\n " ResourceContentResult: type: object description: "Model representing a resource content item.\n " additionalProperties: false required: - contentId properties: contentId: type: integer description: "The content id.\n " format: int64 name: type: - string - 'null' description: "Name of the content\n " description: type: - string - 'null' description: "Description of the content.\n " type: description: "Specific content type.\n " $ref: '#/components/schemas/ContentType' cultureCode: type: - string - 'null' description: "Culture code.\n " IJsonResponseOfIListOfPromotionSettingType: 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/PromotionSettingType' 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' RoleSettingType: type: object description: "The role settings type model.\n " additionalProperties: false required: - roleSettingTypeCode properties: roleSettingTypeCode: type: string description: "The code for the role setting type.\n " maxLength: 20 minLength: 0 name: type: - string - 'null' description: "The name for the role setting type.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The inactive flag for this setting type.\n " IJsonResponseOfIListOfBaggageType: 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/BaggageType' 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' FeeRulePropertyType: type: integer description: "Types of fee rules available.\n \n\n0 = Default\n1 = PassengerType\n2 = FromStationClass\n3 = FareClass\n4 = PassengerResidentCountry\n5 = FeeCode\n6 = ToStationClass\n7 = EventChannel\n8 = OrganizationGroup\n9 = OrganizationCode\n10 = AgentRole\n11 = BestCustomerProgramLevel\n12 = WorstCustomerProgramLevel\n13 = ExactCustomerProgramLevel\n14 = CarrierCode\n15 = SeatGroup\n16 = FeeType\n17 = ProductClass\n18 = SystemCode\n19 = TripType\n20 = PaymentType\n21 = TicketAccountingCode\n22 = SoldChannel\n23 = ItineraryFullyWithinCountry\n24 = ChangeReasonCode\n25 = GuestRecognitionLevel\n26 = FlightType\n27 = FareType\n28 = DayOfWeek\n29 = StartTimeOfDay\n30 = EndTimeOfDay\n31 = StartFlightNumberRange\n32 = EndFlightNumberRange\n33 = MinAdvancedPurchaseDays\n34 = FareDiscount\n35 = BookingStatus\n36 = EarliestAdvancedPurchaseDays\n37 = SalesStartTimeOfDay\n38 = SalesEndTimeOfDay\n39 = BookingCurrency\n40 = CardSubType\n41 = PaymentMethodCode\n42 = ServiceBundle\n43 = CreatedAgentRoleCode\n44 = StartExtraBagRange\n45 = EndExtraBagRange\n46 = JourneyDepartureStation\n47 = JourneyDepartureCountry\n48 = GSTStateCode\n49 = SystemType\n50 = FarePriceType\n51 = GSTTaxOption\n52 = LatestAdvancedPurchaseDays\n53 = TravelDirection\n54 = TransferAndStopoverPoint" x-enumNames: - Default - PassengerType - FromStationClass - FareClass - PassengerResidentCountry - FeeCode - ToStationClass - EventChannel - OrganizationGroup - OrganizationCode - AgentRole - BestCustomerProgramLevel - WorstCustomerProgramLevel - ExactCustomerProgramLevel - CarrierCode - SeatGroup - FeeType - ProductClass - SystemCode - TripType - PaymentType - TicketAccountingCode - SoldChannel - ItineraryFullyWithinCountry - ChangeReasonCode - GuestRecognitionLevel - FlightType - FareType - DayOfWeek - StartTimeOfDay - EndTimeOfDay - StartFlightNumberRange - EndFlightNumberRange - MinAdvancedPurchaseDays - FareDiscount - BookingStatus - EarliestAdvancedPurchaseDays - SalesStartTimeOfDay - SalesEndTimeOfDay - BookingCurrency - CardSubType - PaymentMethodCode - ServiceBundle - CreatedAgentRoleCode - StartExtraBagRange - EndExtraBagRange - JourneyDepartureStation - JourneyDepartureCountry - GSTStateCode - SystemType - FarePriceType - GSTTaxOption - LatestAdvancedPurchaseDays - TravelDirection - TransferAndStopoverPoint enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 SingleSignOnProvider: type: object description: "Defines the single sign on credentials.\n " additionalProperties: false properties: name: type: - string - 'null' description: "The single sign on provider name.\n " maxLength: 64 minLength: 0 authorizationEndpoint: type: - string - 'null' description: "The single sign on provider authorization endpoint.\n " maxLength: 256 minLength: 0 tokenEndpoint: type: - string - 'null' description: "The single sign on provider token endpoint.\n " maxLength: 256 minLength: 0 clientIdentifier: type: - string - 'null' description: "The single sign on provider client identifier.\n " maxLength: 256 minLength: 0 singleSignOnType: type: - string - 'null' description: "The single sign on type.\n " inActive: type: boolean description: "Indicates if the single sign on provider is active.\n " providerKey: type: - string - 'null' description: "A unique identifier for the single sign on provider.\n " CheckDigitType: type: integer description: "Defines the check digit types.\n \n\n0 = Other\n1 = None\n2 = Mod10\n3 = Mod10i\n4 = IACO9093\n5 = NavitaireLoyalty" x-enumNames: - Other - None - Mod10 - Mod10i - IACO9093 - NavitaireLoyalty enum: - 0 - 1 - 2 - 3 - 4 - 5 ResourcePostalCodeResponse: type: object description: "Model representing the resource postal code response.\n " additionalProperties: false properties: postalCodes: type: - array - 'null' description: "The list of postal codes.\n " items: $ref: '#/components/schemas/PostalCode' totalCount: type: integer description: "The total count of all postal codes.\n " format: int32 lastPageKey: type: - string - 'null' description: "Used to specify the last item of the page of the last set of records retrieved\nwhen paging was performed.\n " IJsonResponseOfIListOfCity: 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/City' 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' BundleDates: type: object description: "The bundle dates model.\n " additionalProperties: false properties: effective: type: - string - 'null' description: "The start date when the bundle application is effective.\n " format: date-time effectiveSales: type: - string - 'null' description: "The effective sales date.\n " format: date-time discontinue: type: - string - 'null' description: "The date when the bundle application is discontinued.\n " format: date-time discontinueSales: type: - string - 'null' description: "The discontinued sales date.\n " format: date-time Currencyv2: type: object description: "The currency model.\n " additionalProperties: false required: - currencyCode properties: currencyCode: type: string description: "The unique currency code of currency.\n " maxLength: 3 minLength: 1 description: type: - string - 'null' description: "The description of currency.\n " maxLength: 128 minLength: 0 roundFactor: type: number description: "The round factor of currency.\n " format: decimal displayDigits: type: integer description: "The display digits of currency.\n " format: int32 displayPrefix: type: - string - 'null' description: "The digit prefix of currency.\n " maxLength: 3 minLength: 0 displaySuffix: type: - string - 'null' description: "The digit suffix of currency.\n " maxLength: 3 minLength: 0 inActive: type: boolean description: "The flag indicating if the currency is inactive.\n " ProductClass: type: object description: "The product class model.\n " additionalProperties: false properties: productClassCode: type: - string - 'null' description: "The product class.\n " maxLength: 2 minLength: 1 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 0 rank: type: integer description: "The rank.\n " maximum: 999.0 minimum: 0.0 inActive: type: boolean description: "The in active.\n " IJsonResponseOfPhoneType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PhoneType' 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' RegionFeeBaggage: type: object description: "Region rate model.\n " additionalProperties: false properties: weightDivisorKgs: type: integer description: "Divisor value for weight in Kilograms.\n " weightDivisorLbs: type: integer description: "Divisor value for weight in pounds.\n " IJsonResponseOfHotCardReason: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/HotCardReason' 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' IJsonResponseOfSsrRestrictionResult: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SsrRestrictionResult' 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' NotificationDeliveryMethod: type: object description: "Notification delivery method model.\n " additionalProperties: false properties: createdUserKey: type: - string - 'null' description: "The created user key.\n " createdDate: type: - string - 'null' description: "The date and time the object was created.\n " format: date-time notificationTypeCode: type: - string - 'null' description: "Notification type code of the traveler notification.\n " modifiedUserKey: type: - string - 'null' description: "The modified user key.\n " modifiedDate: type: - string - 'null' description: "The date and time the object was modified.\n " format: date-time name: type: - string - 'null' description: "The name of the notification delivery method.\n " contentType: description: "The content type of the notification delivery method.\n " $ref: '#/components/schemas/NotificationContentType' maximumSubscription: type: integer description: "The maximum number of notification subscriptions allowed for this notification delivery method type.\nA number of 0 indicates no limit to the number of subscriptions allowed.\n " BundleSsrType: type: integer description: "The service bundle ssr enumeration.\n \n\n0 = InBundle\n1 = InBundleUpgrade\n2 = NotInBundle\n3 = InBundleSeat" x-enumNames: - InBundle - InBundleUpgrade - NotInBundle - InBundleSeat enum: - 0 - 1 - 2 - 3 DocumentType: type: object description: "The document type model.\n " additionalProperties: false required: - documentTypeCode properties: documentTypeCode: type: string description: "The document type code.\n " minLength: 1 name: type: - string - 'null' description: "The document type name.\n " group: description: "The document group.\n " $ref: '#/components/schemas/DocumentGroup' isExpirationDateRequired: type: boolean description: "Indicates if an expiration date is required.\n " inActive: type: boolean description: "The in active.\n " IJsonResponseOfResourceCategoryItem: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ResourceCategoryItem' 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' IJsonResponseOfIListOfArea: 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/Area' 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' IJsonResponseOfIListOfBundleApplication: 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/BundleApplication' 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' Printer: type: object description: "Represents a printer.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The printer code.\n " name: type: - string - 'null' description: "The printer name.\n " Zone: type: object description: "The zone model.\n " deprecated: true x-deprecatedMessage: 4.4.1 - Please use Zonev2 instead. additionalProperties: false required: - areaCode - zoneCode properties: areaCode: type: string description: "Gets or sets the area code of this zone.\n " maxLength: 3 minLength: 1 name: type: - string - 'null' description: "Gets or sets the name of this zone.\n " maxLength: 64 minLength: 0 zoneCode: type: string description: "Gets or sets the zone code of this zone.\n " maxLength: 2 minLength: 1 subZones: type: - array - 'null' description: "Gets or sets the list of subzones associated with this zone.\n " items: $ref: '#/components/schemas/SubZone' IJsonResponseOfIListOfShoppingAttribute: 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/ShoppingAttribute' 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' IJsonResponseOfIListOfCarrier: 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/Carrier' 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' IJsonResponseOfIListOfExternalRate: 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/ExternalRate' 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' CustomerProgramv2: type: object description: "The customer program such as loyalty programs.\n " additionalProperties: false properties: programCode: type: - string - 'null' description: "The program code.\n " maxLength: 3 minLength: 0 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 0 programType: description: "The program type.\n " $ref: '#/components/schemas/ProgramType' inActive: type: boolean description: "Indicates if the customer program is active or inactive.\n " customerProgramLevels: type: - array - 'null' description: "The customer program levels.\n " items: $ref: '#/components/schemas/CustomerProgramLevel' checkDigitType: description: "The check digit type validation to apply.\n " $ref: '#/components/schemas/CheckDigitType' IJsonResponseOfSuffix: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Suffix' 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' IJsonResponseOfIssuanceReason: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/IssuanceReason' 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' SeatPropertyType: type: object description: "Represents a seat property type used to represent properties of seats in an equipment configuration.\n " additionalProperties: false properties: code: type: - string - 'null' description: "Seat property type code.\n " name: type: - string - 'null' description: "The name of the seat property type.\n " kind: description: "The value type that the seat property represents.\n " $ref: '#/components/schemas/SeatPropertyTypeKind' values: type: - array - 'null' description: "The list of possible values that could represent a seat property.\n " items: $ref: '#/components/schemas/SeatPropertyValue' isSearchable: type: boolean description: "Indicates when the seat property type is included in a list of searchable properties in the seat assignment\nalgorithm.\n " ShoppingAttributeGroup: type: object description: "Model for a shopping attribute groups.\n " additionalProperties: false required: - shoppingAttributeGroupCode properties: inActive: type: boolean description: "Gets or sets the inactive flag for this shopping attribute group.\n " description: type: - string - 'null' description: "Gets or sets the description for this shopping attribute group.\n " maxLength: 128 minLength: 0 name: type: - string - 'null' description: "Gets or sets the name for this shopping attribute group.\n " maxLength: 64 minLength: 0 shoppingAttributeGroupCode: type: string description: "Gets or sets the code for this shopping attribute group.\n " maxLength: 8 minLength: 0 RegionRate: type: object description: "Region rate model.\n " additionalProperties: false required: - regionCode properties: currencyCode: type: - string - 'null' description: "The currency code of this region rate.\n " maxLength: 3 minLength: 0 rateAmount: type: number description: "The rate amount of this region rate.\n " format: decimal regionCode: type: string description: "The region code of this region rate.\n " maxLength: 5 minLength: 0 regionFeeId: type: - integer - 'null' description: "The region fee ID of this region rate.\n " format: int64 regionRateId: type: integer description: "The region rate ID of this region rate.\n " format: int64 regionType: description: "The type of this region rate.\n " $ref: '#/components/schemas/RegionType' IJsonResponseOfListOfRoleSettingv2: 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/RoleSettingv2' 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' RegionType: type: integer description: "Enum reprenting the the region type used to indicate the kind of region an item is associated with.\n \n\n0 = Default\n1 = Station\n2 = City\n3 = ProvinceState\n4 = Country\n5 = FeeZone\n6 = SubZone\n7 = Area\n8 = All\n9 = Mac" x-enumNames: - Default - Station - City - ProvinceState - Country - FeeZone - SubZone - Area - All - Mac enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 IJsonResponseOfIListOfFee: 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/Fee' 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' ResourceCategoryItem: type: object description: "Model representing a resource setting category item.\n " additionalProperties: false required: - resourceCategoryItemId - resourceCategoryItemTypeCode - name - resourceCategoryId properties: contentType: description: "The default content type.\n " $ref: '#/components/schemas/ResponseContentType' resourceCategoryItemId: type: integer description: "The resource id.\n " format: int64 resourceCategoryItemTypeCode: type: string description: "The resource type code.\n " maxLength: 3 minLength: 1 name: type: string description: "The name.\n " maxLength: 64 minLength: 0 resourceCategoryId: type: integer description: "The resource category id.\n " format: int64 cannotDelete: type: boolean description: "The delete permissions.\n " data: type: - string - 'null' description: "The resource data.\n " maxLength: 1073741823 minLength: 0 IJsonResponseOfIListOfBundleSet: 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/BundleSet' 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' IJsonResponseOfCountryv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Countryv2' 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' IJsonResponseOfTravelerNotification: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/TravelerNotification' 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' IJsonResponseOfIListOfEmailType: 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/EmailType' 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' TravelSegmentIndicator: type: integer description: "Enumeration representing TSI Codes\n \n\n0 = None\n1 = CheckAgainstJourney\n2 = CheckAgainstTrip\n100 = Departure\n101 = DepartureOfTripOrigin\n102 = DepartureAtConnection\n103 = DepartureWithinStopoverTime\n104 = DepartureAtPointOfTurnaround\n105 = DepartureOfTransOceanicSegment\n106 = DepartureFromGateway\n107 = DepartureOfLastSegment\n108 = DepartureExceedsStopoverTime\n109 = NotDepartingViaConnection\n110 = GroundTimeBeforeDepartureOfJourneyWithin\n111 = GroundTimeBeforeDepartureOfJourneyExceeds\n200 = Arrival\n201 = ArrivalOfTransOceanicSegment\n202 = ArrivalAtGateway\n203 = ArrivalAtPointOfTurnaround\n204 = ArrivalAtConnection\n206 = ArrivalAtTripOrigin\n207 = NotDepartingViaConnectionOnSameCalendarDay\n208 = CheckAgainstItinerary\n209 = GroundTimeAfterArrivalAtConnectionWithin\n210 = GroundTimeAfterArrivalAtConnectionExceeds\n211 = GroundTimeAfterArrivalOfJourneyWithin\n212 = GroundTimeAfterArrivalOfJourneyExceeds\n213 = ArrivalAtTripOriginCountry\n214 = ArrivalAtTripOriginCity\n215 = DepartingSameCalendarDay\n216 = NotDepartingSameCalendarDay" x-enumNames: - None - CheckAgainstJourney - CheckAgainstTrip - Departure - DepartureOfTripOrigin - DepartureAtConnection - DepartureWithinStopoverTime - DepartureAtPointOfTurnaround - DepartureOfTransOceanicSegment - DepartureFromGateway - DepartureOfLastSegment - DepartureExceedsStopoverTime - NotDepartingViaConnection - GroundTimeBeforeDepartureOfJourneyWithin - GroundTimeBeforeDepartureOfJourneyExceeds - Arrival - ArrivalOfTransOceanicSegment - ArrivalAtGateway - ArrivalAtPointOfTurnaround - ArrivalAtConnection - ArrivalAtTripOrigin - NotDepartingViaConnectionOnSameCalendarDay - CheckAgainstItinerary - GroundTimeAfterArrivalAtConnectionWithin - GroundTimeAfterArrivalAtConnectionExceeds - GroundTimeAfterArrivalOfJourneyWithin - GroundTimeAfterArrivalOfJourneyExceeds - ArrivalAtTripOriginCountry - ArrivalAtTripOriginCity - DepartingSameCalendarDay - NotDepartingSameCalendarDay enum: - 0 - 1 - 2 - 100 - 101 - 102 - 103 - 104 - 105 - 106 - 107 - 108 - 109 - 110 - 111 - 200 - 201 - 202 - 203 - 204 - 206 - 207 - 208 - 209 - 210 - 211 - 212 - 213 - 214 - 215 - 216 IJsonResponseOfMessageType: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/MessageType' 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' CreditExpirationType: type: integer description: "Credit expiration type enumeration.\n \n\n0 = None\n1 = FixedAtIssuance\n2 = FixedDate\n3 = FixedAtBooking" x-enumNames: - None - FixedAtIssuance - FixedDate - FixedAtBooking enum: - 0 - 1 - 2 - 3 IJsonResponseOfProductClass: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ProductClass' 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' IJsonResponseOfIListOfBundleSsrConfiguration: 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/BundleSsrConfiguration' 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' IJsonResponseOfIListOfBundleConfiguration: 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/BundleConfiguration' 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' IJsonResponseOfIListOfPhoneType: 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/PhoneType' 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' IJsonResponseOfStationCategory: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/StationCategory' 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' IJsonResponseOfIListOfRolev2: 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/Rolev2' 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' Domain: type: object description: "The domain model.\n " additionalProperties: false required: - domainCode properties: domainCode: type: string description: "The domain code.\n " maxLength: 3 minLength: 0 name: type: - string - 'null' description: "The domain name.\n " maxLength: 64 minLength: 0 pattern: ^[^\[\]]*$ passwordNeverExpires: type: boolean description: "Set to true if the password will never expire.\n " minimumPasswordAge: type: - integer - 'null' description: "Minimum Password Age is the amount of days that a password must live before it can be\nchanged. This is to prevent an Agent from changing their password the required amount\nof times so that the system allows her to return to her original password. For\nexample, if my pwd (12345) expires, and I don't want to change it, without this\nMinimum Password Age I could change it manually the right number of times and then\nchange it back to 12345, thus defeating the purpose of requiring the change in the\nfirst place.\nIf the field is set to null, the system should never prevent an\nAgent from changing her password. The example above would be perfectly valid.\n " maximum: 32767.0 minimum: 1.0 maximumPasswordAge: type: - integer - 'null' description: "The Maximum Password Age is the amount of time a password can live before the system\nforces it to be changed. If this is set to null, the system\nwould never force an Agent to change their password.\n " maximum: 32767.0 minimum: 1.0 maximumFaliedLogons: type: - integer - 'null' description: "After failing logon the amount of times specified by this field the locked bit is\nflipped on the Agent. No more logon attempts from the UI will be accepted for that\nAgent name. This locked bit can be flipped (on or off) manually in the Agents dialog\nin SkyManager.\nSetting this field to null would also indicate that logon can be\nattempted an unlimited amount of times for an Agent.\n " maximum: 32767.0 minimum: 1.0 uniquePasswordCount: type: - integer - 'null' description: "The system forces the Agent to not re-use a password that it remembers the Agent has\nused. This field defines how many passwords the system remembers for an Agent. So if\nthis field is set to two and if my password was 12345, then when my password is\nchanged I would have to have two other passwords before I could reuse 12345.\nThis field does NOT specify how many Agents can have the same password. As far as the\nsystem is concerned every Agent can have the same password.\n " maximum: 32767.0 minimum: 1.0 passwordPolicy: description: "The password policy.\n " $ref: '#/components/schemas/RegularExpressionPolicy' usernamePolicy: description: "The regular expression that defines the rules for the username policy.\n " $ref: '#/components/schemas/RegularExpressionPolicy' allowed: type: boolean description: "True if the domain is allowed to use.\n " useNewResetPasswordFlow: type: boolean description: "Indicates whether the agents in the domain are allowed to use the new reset password flow.\n " challengeCodeContactMethod: description: "Indicates the required contact method for sending challenge codes.\n " $ref: '#/components/schemas/ChallengeCodeContactMethod' maximumFailedPasswordResets: type: - integer - 'null' description: "The number of times the agent can fail within the password reset flow before they are placed into a sandbag state.\nThe sandbag state is when the user will not be able to attempt another password reset for a specified amount of\ntime.\n " challengeCodeExpirationMinutes: type: - integer - 'null' description: "The time in minutes before a challenge code expires.\n " failedPasswordResetMinutes: type: - integer - 'null' description: "The number of minutes the agent will be required to wait if they exceed the maximum allowed failed password resets.\n " SsrGroupItem: type: object description: "The SSR group SSR model.\n " additionalProperties: false properties: ssrGroupCode: type: - string - 'null' description: "The SSR group Code.\n " maxLength: 4 minLength: 1 ssrCode: type: - string - 'null' description: "The SSR Code.\n " maxLength: 4 minLength: 1 IJsonResponseOfSubZonev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/SubZonev2' 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' ShoppingAttribute: type: object description: "Model for a shopping attribute.\n " additionalProperties: false required: - shoppingAttributeCode properties: inActive: type: boolean description: "Gets or sets the flag for inactive for this shopping attribute.\n " description: type: - string - 'null' description: "Gets or sets the description of this shopping attribute.\n " maxLength: 128 minLength: 0 name: type: - string - 'null' description: "Gets or sets the name of this shopping attribute.\n " maxLength: 64 minLength: 0 shoppingAttributeCode: type: string description: "Gets or sets the code of this shopping attribute.\n " maxLength: 8 minLength: 0 shoppingAttributeGroupCodes: type: - array - 'null' description: "Gets or sets the list of group codes associated with this shopping attribute.\n " items: type: string shoppingAttributeType: description: "Gets or sets the type of this shopping attribute.\n " $ref: '#/components/schemas/ShoppingAttributeType' IJsonResponseOfIListOfString: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: type: string 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' IJsonResponseOfIListOfContactType: 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/ContactType' 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' RoleSettingv2: type: object description: "The role settings model.\n " additionalProperties: false required: - code properties: code: type: string description: "The code for the role setting type.\n " maxLength: 20 minLength: 0 name: type: - string - 'null' description: "The name for the role setting type.\n " maxLength: 64 minLength: 0 IJsonResponseOfIListOfSsrNest: 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/SsrNest' 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' IJsonResponseOfIListOfShoppingAttributeGroup: 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/ShoppingAttributeGroup' 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' IJsonResponseOfIListOfSsrGroup: 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/SsrGroup' 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' IJsonResponseOfIEnumerableOfResourceContentResult: 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/ResourceContentResult' 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' IJsonResponseOfPaymentMethod: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PaymentMethod' 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' PassengerType: type: object description: "The passenger type model.\n " additionalProperties: false required: - passengerTypeCode properties: nonAdult: type: boolean description: "The non-adult for the passenger type.\n " passengerTypeCode: type: string description: "The code for the passenger type.\n " maxLength: 4 minLength: 1 name: type: - string - 'null' description: "The name for the passenger type.\n " maxLength: 64 minLength: 0 allowed: type: boolean description: "The allowed flag for the passenger type.\n " inActive: type: boolean description: "The inactive flag for the passenger type.\n " typeIndicator: description: "The type indicator specifying the age group this belongs to.\n " $ref: '#/components/schemas/PassengerTypeIndicator' minimumAge: type: integer description: "The minimum age for the passenger type.\n " maximumAge: type: integer description: "The maximum age for the passenger type.\n " Station: type: object description: "Defines a station.\n " additionalProperties: false required: - stationCode properties: stationCode: type: string description: "The station unique code.\n " maxLength: 3 minLength: 0 inActive: type: boolean description: "The flag indicating if the station is inactive.\n " allowed: type: boolean description: "Deprecated - Please use api/nsk/v1/settings/general/codes endpoint to verify role based access instead.\n " icaoCode: type: - string - 'null' description: "The International Civil Aviation Organization (ICAO) code for the station.\n " fullName: type: - string - 'null' description: "The full display name.\n " maxLength: 64 minLength: 0 shortName: type: - string - 'null' description: "The short display name.\n " macCode: type: - string - 'null' description: "The stations MAC (multiple airport code) code.\n " currencyCode: type: - string - 'null' description: "The stations default currency code.\n " maxLength: 3 minLength: 0 conversionCurrencyCode: type: - string - 'null' description: "The stations configured conversion currency code.\n " maxLength: 3 minLength: 0 cultureCode: type: - string - 'null' description: "The culture code.\n " maxLength: 17 minLength: 0 class: type: string description: "The stations configured class.\nPlease note that this should be a char and not a string.\n " maxLength: 1 locationDetails: description: "The stations location details.\n " $ref: '#/components/schemas/StationLocationDetails' IJsonResponseOfShoppingAttribute: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ShoppingAttribute' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' MessageStatus: type: integer description: "Defines the message status.\n \n\n0 = General\n1 = Warning\n2 = Critical" x-enumNames: - General - Warning - Critical enum: - 0 - 1 - 2 IJsonResponseOfIListOfCountryv2: 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/Countryv2' 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' IJsonResponseOfMarketv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Marketv2' 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' FeeRulePropertyOperator: type: integer description: "Enum representing the fee rule property operator.\n \n\n0 = Default\n1 = MustBe\n2 = MustNotBe\n3 = AllMustBe" x-enumNames: - Default - MustBe - MustNotBe - AllMustBe enum: - 0 - 1 - 2 - 3 IJsonResponseOfTravelClass: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/TravelClass' 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' ChargeLimitMode: type: integer description: "Enumeration representing the mode when the charge limit is applied.\n \n\n0 = FirstOccurrences\n1 = LastOccurrences\n2 = FirstOutLastInOccurrences" x-enumNames: - FirstOccurrences - LastOccurrences - FirstOutLastInOccurrences enum: - 0 - 1 - 2 FeeRuleProperty: type: object description: "Fee rule property model.\n " additionalProperties: false properties: propertyNumber: type: integer description: "Gets or sets the fee property number of this fee rule property.\n " maximum: 32767.0 minimum: 0.0 ruleNumber: type: integer description: "Gets or sets the fee rule number of this fee rule property.\n " maximum: 32767.0 minimum: 0.0 operator: description: "Gets or sets the property operator of this fee rule property.\n " $ref: '#/components/schemas/FeeRulePropertyOperator' type: description: "Gets or sets the property type of this fee rule property.\n " $ref: '#/components/schemas/FeeRulePropertyType' propertyValue: type: - string - 'null' description: "Gets or sets the property value of this fee rule property.\n " maxLength: 6 minLength: 0 LocationType: type: integer description: "The location type enumeration.\n \n\n0 = Other\n1 = Station\n2 = City" x-enumNames: - Other - Station - City enum: - 0 - 1 - 2 BaggageType: type: object description: "The baggage type model.\n " additionalProperties: false required: - baggageTypeCode properties: baggageTypeCode: type: string description: "Gets or sets the baggage type code.\n " maxLength: 6 minLength: 1 bagWeightType: description: "Gets or sets the bag weight type.\n " $ref: '#/components/schemas/WeightType' freeBag: type: boolean description: "Gets or sets the free bag flag.\n " inActive: type: boolean description: "Gets or sets the inactive flag.\n " name: type: - string - 'null' description: "Gets or sets the name of the baggage type.\n " maxLength: 64 minLength: 0 weightReducedBy: type: integer description: "Gets or sets the weight reduced by value.\n " maximum: 999.0 minimum: 0.0 includeInBaggageCount: type: boolean description: "Indicates if the baggage type will be displayed in the GoNow baggage count.\n " IJsonResponseOfIListOfTimeZone: 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/TimeZone' 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' RefundCurrencyControl: type: integer description: "Enum representing the currency control on a refund.\n \n\n0 = UseCollectedCurrency\n1 = UseQuotedCurrency" x-enumNames: - UseCollectedCurrency - UseQuotedCurrency enum: - 0 - 1 IJsonResponseOfIListOfTravelClass: 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/TravelClass' 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' HotCardReason: type: object description: "The hot card reason model.\n " additionalProperties: false required: - hotCardReasonCode properties: hotCardReasonCode: type: string description: "The reason code.\n " maxLength: 4 minLength: 0 name: type: - string - 'null' description: "The name.\n " maxLength: 64 minLength: 0 inActive: type: boolean description: "The in active.\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))